The sanitize Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The sanitize Reference Manual

This is the sanitize Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:58:31 2022 GMT+0.

Table of Contents


1 Introduction

.. -*- rst -*-

CL-SANITIZE
===========

cl-sanitize is a whitelist-based HTML sanitizer. Given a list of acceptable
elements and attributes, cl-sanitize will remove all unacceptable HTML from
a string.

cl-sanitize is a Common Lisp port of `Sanitize`_.

Requires
========

* `cl-libxml2`_

.. _Sanitize: https://github.com/rgrove/sanitize
.. _cl-libxml2: http://code.google.com/p/cl-libxml2/


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 sanitize

Dependency

cl-libxml2 (system).

Source

sanitize.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 sanitize/src

Source

sanitize.asd.

Parent Component

sanitize (system).

Child Components

Previous: , Up: Modules   [Contents][Index]

3.2 sanitize/src/modes

Dependency

mode.lisp (file).

Source

sanitize.asd.

Parent Component

src (module).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

4.1.1 sanitize/sanitize.asd

Source

sanitize.asd.

Parent Component

sanitize (system).

ASDF Systems

sanitize.


4.1.2 sanitize/src/package.lisp

Source

sanitize.asd.

Parent Component

src (module).

Packages

sanitize.


4.1.3 sanitize/src/mode.lisp

Dependency

package.lisp (file).

Source

sanitize.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 sanitize/src/clean.lisp

Dependency

mode.lisp (file).

Source

sanitize.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 sanitize/src/modes/basic.lisp

Source

sanitize.asd.

Parent Component

modes (module).

Public Interface

+basic+ (special variable).


4.1.6 sanitize/src/modes/relaxed.lisp

Source

sanitize.asd.

Parent Component

modes (module).

Public Interface

+relaxed+ (special variable).


4.1.7 sanitize/src/modes/restricted.lisp

Source

sanitize.asd.

Parent Component

modes (module).

Public Interface

+restricted+ (special variable).


5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 sanitize

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Public Interface


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

6.1.1 Special variables

Special Variable: +basic+
Package

sanitize.

Source

basic.lisp.

Special Variable: +default+
Package

sanitize.

Source

mode.lisp.

Special Variable: +relaxed+
Package

sanitize.

Source

relaxed.lisp.

Special Variable: +restricted+
Package

sanitize.

Source

restricted.lisp.


6.1.2 Macros

Macro: define-sanitize-mode (name &key allow-comments add-attributes attributes elements protocols whitespace-elements remove-elements)
Package

sanitize.

Source

mode.lisp.

Macro: with-clean-fragment ((fragment html mode) &body body)
Package

sanitize.

Source

clean.lisp.


6.1.3 Ordinary functions

Function: clean (html &optional mode)

Return sanitize copy of HTML

Package

sanitize.

Source

clean.lisp.


6.1.4 Standalone methods

Method: shared-initialize :after ((mode sanitize-mode) slot-names &key &allow-other-keys)
Source

mode.lisp.


6.1.5 Classes

Class: sanitize-mode
Package

sanitize.

Source

mode.lisp.

Direct methods
Direct slots
Slot: allow-comments
Initargs

:allow-comments

Readers

mode-allow-comments.

Writers

This slot is read-only.

Slot: add-attributes
Initargs

:add-attributes

Readers

mode-add-attributes.

Writers

This slot is read-only.

Slot: attributes
Initargs

:attributes

Readers

mode-attributes.

Writers

This slot is read-only.

Slot: elements
Initargs

:elements

Readers

mode-elements.

Writers

This slot is read-only.

Slot: protocols
Initargs

:protocols

Readers

mode-protocols.

Writers

This slot is read-only.

Slot: whitespace-elements
Initargs

:whitespace-elements

Readers

mode-whitespace-elements.

Writers

This slot is read-only.

Slot: remove-elements
Initargs

:remove-elements

Readers

mode-remove-elements.

Writers

This slot is read-only.


6.2 Internals


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

6.2.1 Ordinary functions

Function: attribute-allowed-p (mode tagname attrname)
Package

sanitize.

Source

mode.lisp.

Function: clean-element (element mode &optional tagname)
Package

sanitize.

Source

clean.lisp.

Function: clean-node (node mode)
Package

sanitize.

Source

clean.lisp.

Function: element-additional-attributes (mode tagname)
Package

sanitize.

Source

mode.lisp.

Function: element-allowed-p (mode tagname)
Package

sanitize.

Source

mode.lisp.

Function: element-protocols (mode tagname)
Package

sanitize.

Source

mode.lisp.

Function: element-removed-p (mode tagname)
Package

sanitize.

Source

mode.lisp.

Function: whitespace-element-p (mode tagname)
Package

sanitize.

Source

mode.lisp.


6.2.2 Generic functions

Generic Reader: mode-add-attributes (object)
Package

sanitize.

Methods
Reader Method: mode-add-attributes ((sanitize-mode sanitize-mode))

automatically generated reader method

Source

mode.lisp.

Target Slot

add-attributes.

Generic Reader: mode-allow-comments (object)
Package

sanitize.

Methods
Reader Method: mode-allow-comments ((sanitize-mode sanitize-mode))

automatically generated reader method

Source

mode.lisp.

Target Slot

allow-comments.

Generic Reader: mode-attributes (object)
Package

sanitize.

Methods
Reader Method: mode-attributes ((sanitize-mode sanitize-mode))

automatically generated reader method

Source

mode.lisp.

Target Slot

attributes.

Generic Reader: mode-elements (object)
Package

sanitize.

Methods
Reader Method: mode-elements ((sanitize-mode sanitize-mode))

automatically generated reader method

Source

mode.lisp.

Target Slot

elements.

Generic Reader: mode-protocols (object)
Package

sanitize.

Methods
Reader Method: mode-protocols ((sanitize-mode sanitize-mode))

automatically generated reader method

Source

mode.lisp.

Target Slot

protocols.

Generic Reader: mode-remove-elements (object)
Package

sanitize.

Methods
Reader Method: mode-remove-elements ((sanitize-mode sanitize-mode))

automatically generated reader method

Source

mode.lisp.

Target Slot

remove-elements.

Generic Reader: mode-whitespace-elements (object)
Package

sanitize.

Methods
Reader Method: mode-whitespace-elements ((sanitize-mode sanitize-mode))

automatically generated reader method

Source

mode.lisp.

Target Slot

whitespace-elements.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   C   D   E   F   G   M   S   W  
Index Entry  Section

A
attribute-allowed-p: Private ordinary functions

C
clean: Public ordinary functions
clean-element: Private ordinary functions
clean-node: Private ordinary functions

D
define-sanitize-mode: Public macros

E
element-additional-attributes: Private ordinary functions
element-allowed-p: Private ordinary functions
element-protocols: Private ordinary functions
element-removed-p: Private ordinary functions

F
Function, attribute-allowed-p: Private ordinary functions
Function, clean: Public ordinary functions
Function, clean-element: Private ordinary functions
Function, clean-node: Private ordinary functions
Function, element-additional-attributes: Private ordinary functions
Function, element-allowed-p: Private ordinary functions
Function, element-protocols: Private ordinary functions
Function, element-removed-p: Private ordinary functions
Function, whitespace-element-p: Private ordinary functions

G
Generic Function, mode-add-attributes: Private generic functions
Generic Function, mode-allow-comments: Private generic functions
Generic Function, mode-attributes: Private generic functions
Generic Function, mode-elements: Private generic functions
Generic Function, mode-protocols: Private generic functions
Generic Function, mode-remove-elements: Private generic functions
Generic Function, mode-whitespace-elements: Private generic functions

M
Macro, define-sanitize-mode: Public macros
Macro, with-clean-fragment: Public macros
Method, mode-add-attributes: Private generic functions
Method, mode-allow-comments: Private generic functions
Method, mode-attributes: Private generic functions
Method, mode-elements: Private generic functions
Method, mode-protocols: Private generic functions
Method, mode-remove-elements: Private generic functions
Method, mode-whitespace-elements: Private generic functions
Method, shared-initialize: Public standalone methods
mode-add-attributes: Private generic functions
mode-add-attributes: Private generic functions
mode-allow-comments: Private generic functions
mode-allow-comments: Private generic functions
mode-attributes: Private generic functions
mode-attributes: Private generic functions
mode-elements: Private generic functions
mode-elements: Private generic functions
mode-protocols: Private generic functions
mode-protocols: Private generic functions
mode-remove-elements: Private generic functions
mode-remove-elements: Private generic functions
mode-whitespace-elements: Private generic functions
mode-whitespace-elements: Private generic functions

S
shared-initialize: Public standalone methods

W
whitespace-element-p: Private ordinary functions
with-clean-fragment: Public macros

Jump to:   A   C   D   E   F   G   M   S   W