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.

1 Introduction
2 Systems
- 2.1 sanitize
3 Modules
- 3.1 sanitize/src
- 3.2 sanitize/src/modes
4 Files
- 4.1 Lisp
5 Packages
- 5.1 sanitize
6 Definitions
- 6.1 Public Interface
- 6.2 Internals
  - 6.2.1 Ordinary functions
  - 6.2.2 Generic functions
Appendix A Indexes

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.

sanitize

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.

sanitize/src
sanitize/src/modes

3.1 `sanitize/src`

Source

sanitize.asd.

Parent Component

sanitize (system).

Child Components

package.lisp (file).
mode.lisp (file).
clean.lisp (file).
modes (module).

3.2 `sanitize/src/modes`

Dependency

mode.lisp (file).

Source

sanitize.asd.

Parent Component

src (module).

Child Components

basic.lisp (file).
relaxed.lisp (file).
restricted.lisp (file).

4 Files

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

Lisp

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

+default+ (special variable).
define-sanitize-mode (macro).
sanitize-mode (class).
shared-initialize (method).

Internals

attribute-allowed-p (function).
element-additional-attributes (function).
element-allowed-p (function).
element-protocols (function).
element-removed-p (function).
mode-add-attributes (reader method).
mode-allow-comments (reader method).
mode-attributes (reader method).
mode-elements (reader method).
mode-protocols (reader method).
mode-remove-elements (reader method).
mode-whitespace-elements (reader method).
whitespace-element-p (function).

4.1.4 `sanitize/src/clean.lisp`

Dependency

mode.lisp (file).

Source

sanitize.asd.

Parent Component

src (module).

Public Interface

clean (function).
with-clean-fragment (macro).

Internals

clean-element (function).
clean-node (function).

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.

sanitize

5.1 `sanitize`

Source

package.lisp.

Use List

common-lisp.

Public Interface

+basic+ (special variable).
+default+ (special variable).
+relaxed+ (special variable).
+restricted+ (special variable).
clean (function).
define-sanitize-mode (macro).
sanitize-mode (class).
with-clean-fragment (macro).

Internals

attribute-allowed-p (function).
clean-element (function).
clean-node (function).
element-additional-attributes (function).
element-allowed-p (function).
element-protocols (function).
element-removed-p (function).
mode-add-attributes (generic reader).
mode-allow-comments (generic reader).
mode-attributes (generic reader).
mode-elements (generic reader).
mode-protocols (generic reader).
mode-remove-elements (generic reader).
mode-whitespace-elements (generic reader).
whitespace-element-p (function).

6 Definitions

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

Public Interface
Internals

6.1 Public Interface

Special variables
Macros
Ordinary functions
Standalone methods
Classes

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

mode-add-attributes.
mode-allow-comments.
mode-attributes.
mode-elements.
mode-protocols.
mode-remove-elements.
mode-whitespace-elements.
shared-initialize.

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

Ordinary functions
Generic functions

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

Concepts
Functions
Variables
Data types

A.1 Concepts

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

A.3 Variables

Jump to:	+ A E P R S W

	Index Entry	Section

+
	`+basic+`:	Public special variables
	`+default+`:	Public special variables
	`+relaxed+`:	Public special variables
	`+restricted+`:	Public special variables

A
	`add-attributes`:	Public classes
	`allow-comments`:	Public classes
	`attributes`:	Public classes

E
	`elements`:	Public classes

P
	`protocols`:	Public classes

R
	`remove-elements`:	Public classes

S
	`Slot, add-attributes`:	Public classes
	`Slot, allow-comments`:	Public classes
	`Slot, attributes`:	Public classes
	`Slot, elements`:	Public classes
	`Slot, protocols`:	Public classes
	`Slot, remove-elements`:	Public classes
	`Slot, whitespace-elements`:	Public classes
	`Special Variable, +basic+`:	Public special variables
	`Special Variable, +default+`:	Public special variables
	`Special Variable, +relaxed+`:	Public special variables
	`Special Variable, +restricted+`:	Public special variables

W
	`whitespace-elements`:	Public classes

Jump to:	+ A E P R S W

A.4 Data types

Jump to:	B C F M P R S

	Index Entry	Section

B
	`basic.lisp`:	The sanitize/src/modes/basic․lisp file

C
	`Class, sanitize-mode`:	Public classes
	`clean.lisp`:	The sanitize/src/clean․lisp file

F
	`File, basic.lisp`:	The sanitize/src/modes/basic․lisp file
	`File, clean.lisp`:	The sanitize/src/clean․lisp file
	`File, mode.lisp`:	The sanitize/src/mode․lisp file
	`File, package.lisp`:	The sanitize/src/package․lisp file
	`File, relaxed.lisp`:	The sanitize/src/modes/relaxed․lisp file
	`File, restricted.lisp`:	The sanitize/src/modes/restricted․lisp file
	`File, sanitize.asd`:	The sanitize/sanitize․asd file

M
	`mode.lisp`:	The sanitize/src/mode․lisp file
	`modes`:	The sanitize/src/modes module
	`Module, modes`:	The sanitize/src/modes module
	`Module, src`:	The sanitize/src module

P
	`Package, sanitize`:	The sanitize package
	`package.lisp`:	The sanitize/src/package․lisp file

R
	`relaxed.lisp`:	The sanitize/src/modes/relaxed․lisp file
	`restricted.lisp`:	The sanitize/src/modes/restricted․lisp file

S
	`sanitize`:	The sanitize system
	`sanitize`:	The sanitize package
	`sanitize-mode`:	Public classes
	`sanitize.asd`:	The sanitize/sanitize․asd file
	`src`:	The sanitize/src module
	`System, sanitize`:	The sanitize system

Jump to:	B C F M P R S

The sanitize Reference Manual

The sanitize Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 sanitize

3 Modules

3.1 sanitize/src

3.2 sanitize/src/modes

4 Files

4.1 Lisp

4.1.1 sanitize/sanitize.asd

4.1.2 sanitize/src/package.lisp

4.1.3 sanitize/src/mode.lisp

4.1.4 sanitize/src/clean.lisp

4.1.5 sanitize/src/modes/basic.lisp

4.1.6 sanitize/src/modes/relaxed.lisp

4.1.7 sanitize/src/modes/restricted.lisp

5 Packages

5.1 sanitize

6 Definitions

6.1 Public Interface

6.1.1 Special variables

6.1.2 Macros

6.1.3 Ordinary functions

6.1.4 Standalone methods

6.1.5 Classes

6.2 Internals

6.2.1 Ordinary functions

6.2.2 Generic functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `sanitize`

3.1 `sanitize/src`

3.2 `sanitize/src/modes`

4.1.1 `sanitize/sanitize.asd`

4.1.2 `sanitize/src/package.lisp`

4.1.3 `sanitize/src/mode.lisp`

4.1.4 `sanitize/src/clean.lisp`

4.1.5 `sanitize/src/modes/basic.lisp`

4.1.6 `sanitize/src/modes/relaxed.lisp`

4.1.7 `sanitize/src/modes/restricted.lisp`

5.1 `sanitize`