The sanitize Reference Manual

Table of Contents

The sanitize Reference Manual

This is the sanitize Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:22:07 2018 GMT+0.

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.

2.1 sanitize

Dependency

cl-libxml2

Source

sanitize.asd (file)

Component

src (module)

3 Modules

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

3.1 sanitize/src

Parent

sanitize (system)

Location

src/

Components

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

3.2 sanitize/src/modes

Dependency

mode.lisp (file)

Parent

src (module)

Location

src/modes/

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.

4.1 Lisp

4.1.1 sanitize.asd

Location

sanitize.asd

Systems

sanitize (system)

4.1.2 sanitize/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

sanitize

4.1.3 sanitize/src/mode.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/mode.lisp

Exported Definitions

• +default+ (special variable)
• define-sanitize-mode (macro)
• sanitize-mode (class)

Internal Definitions

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

4.1.4 sanitize/src/clean.lisp

Dependency

mode.lisp (file)

Parent

src (module)

Location

src/clean.lisp

Exported Definitions

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

Internal Definitions

• clean-element (function)
• clean-node (function)

4.1.5 sanitize/src/modes/basic.lisp

Parent

modes (module)

Location

src/modes/basic.lisp

Exported Definitions

+basic+ (special variable)

4.1.6 sanitize/src/modes/relaxed.lisp

Parent

modes (module)

Location

src/modes/relaxed.lisp

Exported Definitions

+relaxed+ (special variable)

4.1.7 sanitize/src/modes/restricted.lisp

Parent

modes (module)

Location

src/modes/restricted.lisp

Exported Definitions

+restricted+ (special variable)

5 Packages

Packages are listed by definition order.

5.1 sanitize

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• +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)

Internal Definitions

• 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 function)
• mode-add-attributes (method)
• mode-allow-comments (generic function)
• mode-allow-comments (method)
• mode-attributes (generic function)
• mode-attributes (method)
• mode-elements (generic function)
• mode-elements (method)
• mode-protocols (generic function)
• mode-protocols (method)
• mode-remove-elements (generic function)
• mode-remove-elements (method)
• mode-whitespace-elements (generic function)
• mode-whitespace-elements (method)
• whitespace-element-p (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: +basic+

Package

sanitize

Source

basic.lisp (file)

Special Variable: +default+

Package

sanitize

Source

mode.lisp (file)

Special Variable: +relaxed+

Package

sanitize

Source

relaxed.lisp (file)

Special Variable: +restricted+

Package

sanitize

Source

restricted.lisp (file)

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 (file)

Macro: with-clean-fragment (FRAGMENT HTML MODE) &body BODY

Package

sanitize

Source

clean.lisp (file)

6.1.3 Functions

Function: clean HTML &optional MODE

Return sanitize copy of HTML

Package

sanitize

Source

clean.lisp (file)

6.1.4 Classes

Class: sanitize-mode ()

Package

sanitize

Source

mode.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• shared-initialize (method)
• mode-remove-elements (method)
• mode-whitespace-elements (method)
• mode-protocols (method)
• mode-elements (method)
• mode-attributes (method)
• mode-add-attributes (method)
• mode-allow-comments (method)

Direct slots

Slot: allow-comments

Initargs

:allow-comments

Readers

mode-allow-comments (generic function)

Slot: add-attributes

Initargs

:add-attributes

Readers

mode-add-attributes (generic function)

Slot: attributes

Initargs

:attributes

Readers

mode-attributes (generic function)

Slot: elements

Initargs

:elements

Readers

mode-elements (generic function)

Slot: protocols

Initargs

:protocols

Readers

mode-protocols (generic function)

Slot: whitespace-elements

Initargs

:whitespace-elements

Readers

mode-whitespace-elements (generic function)

Slot: remove-elements

Initargs

:remove-elements

Readers

mode-remove-elements (generic function)

6.2 Internal definitions

6.2.1 Functions

Function: attribute-allowed-p MODE TAGNAME ATTRNAME

Package

sanitize

Source

mode.lisp (file)

Function: clean-element ELEMENT MODE &optional TAGNAME

Package

sanitize

Source

clean.lisp (file)

Function: clean-node NODE MODE

Package

sanitize

Source

clean.lisp (file)

Function: element-additional-attributes MODE TAGNAME

Package

sanitize

Source

mode.lisp (file)

Function: element-allowed-p MODE TAGNAME

Package

sanitize

Source

mode.lisp (file)

Function: element-protocols MODE TAGNAME

Package

sanitize

Source

mode.lisp (file)

Function: element-removed-p MODE TAGNAME

Package

sanitize

Source

mode.lisp (file)

Function: whitespace-element-p MODE TAGNAME

Package

sanitize

Source

mode.lisp (file)

6.2.2 Generic functions

Generic Function: mode-add-attributes OBJECT

Package

sanitize

Methods

Method: mode-add-attributes (SANITIZE-MODE sanitize-mode)

automatically generated reader method

Source

mode.lisp (file)

Generic Function: mode-allow-comments OBJECT

Package

sanitize

Methods

Method: mode-allow-comments (SANITIZE-MODE sanitize-mode)

automatically generated reader method

Source

mode.lisp (file)

Generic Function: mode-attributes OBJECT

Package

sanitize

Methods

Method: mode-attributes (SANITIZE-MODE sanitize-mode)

automatically generated reader method

Source

mode.lisp (file)

Generic Function: mode-elements OBJECT

Package

sanitize

Methods

Method: mode-elements (SANITIZE-MODE sanitize-mode)

automatically generated reader method

Source

mode.lisp (file)

Generic Function: mode-protocols OBJECT

Package

sanitize

Methods

Method: mode-protocols (SANITIZE-MODE sanitize-mode)

automatically generated reader method

Source

mode.lisp (file)

Generic Function: mode-remove-elements OBJECT

Package

sanitize

Methods

Method: mode-remove-elements (SANITIZE-MODE sanitize-mode)

automatically generated reader method

Source

mode.lisp (file)

Generic Function: mode-whitespace-elements OBJECT

Package

sanitize

Methods

Method: mode-whitespace-elements (SANITIZE-MODE sanitize-mode)

automatically generated reader method

Source

mode.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types