Difuse/luci
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

luci-base(-libs): move pcdata() and striptags() from util- to xml-class

Browse source 
To complete the previous commit these functions are defined in the resulting
luci-base package but are also used in the new luci-base-libs package. So
move them into the new xml-module of the new package.

Signed-off-by: Sven Roederer <freifunk@it-solutions.geroedel.de>
This commit is contained in:
Sven Roederer 2019-07-06 14:18:15 +02:00 committed by Jo-Philipp Wich
parent 8b8d83e42d
commit 68521fca04
42 changed files with 545 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/api/index.html
View file

@ -126,6 +126,10 @@
<a href="modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="modules/nixio.html">nixio</a>
</li>
@ -328,6 +332,11 @@ LuCI system utilities / wifi related functions.</td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="modules/luci.xml.html">luci.xml</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="modules/nixio.html">nixio</a></td>
<td class="summary">

4
docs/api/modules/luci.dispatcher.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.http.conditionals.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.http.date.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.http.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.http.mime.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.i18n.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.ip.cidr.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.ip.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.json.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.jsonc.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.jsonc.parser.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.model.ipkg.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.model.uci.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.rpcc.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.rpcc.ruci.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.sys.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.sys.init.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.sys.iptparser.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.sys.net.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.sys.process.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.sys.user.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/luci.sys.wifi.html
View file

@ -124,6 +124,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

78
docs/api/modules/luci.util.html
View file

@ -124,6 +124,10 @@
<li><strong>luci.util</strong></li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>
@ -342,10 +346,11 @@ value or 0 if the unit is unknown.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#pcdata">pcdata</a>&nbsp;(value)</td>
<td class="name" nowrap><a href="luci.xml.html#pcdata">pcdata</a>&nbsp;(value)</td>
<td class="summary">
Create valid XML PCDATA from given string.</td>
Create valid XML PCDATA from given string.
This is a wrapper for <a href="luci.xml.html#pcdata">luci.xml.pcdata()</a>.</td>
</tr>
<tr>
@ -409,10 +414,11 @@ Strips unnecessary lua bytecode from given string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#striptags">striptags</a>&nbsp;(value)</td>
<td class="name" nowrap><a href="luci.xml.html#striptags">striptags</a>&nbsp;(value)</td>
<td class="summary">
Strip HTML tags from given string.</td>
Strip HTML tags from given string.
This is a wrapper for <a href="luci.xml.html#striptags">luci.xml.striptags()</a>.</td>
</tr>
<tr>
@ -1178,38 +1184,6 @@ Number containing the canonical value
<dt><a name="pcdata"></a><strong>pcdata</strong>&nbsp;(value)</dt>
<dd>
Create valid XML PCDATA from given string.
<h3>Parameters</h3>
<ul>
<li>
value: String value containing the data to escape
</li>
</ul>
<h3>Return value:</h3>
String value containing the escaped data
</dd>
<dt><a name="perror"></a><strong>perror</strong>&nbsp;(obj)</dt>
<dd>
@ -1524,38 +1498,6 @@ String value containing the stripped lua byte code
<dt><a name="striptags"></a><strong>striptags</strong>&nbsp;(value)</dt>
<dd>
Strip HTML tags from given string.
<h3>Parameters</h3>
<ul>
<li>
value: String containing the HTML text
</li>
</ul>
<h3>Return value:</h3>
String with HTML tags stripped of
</dd>
<dt><a name="threadlocal"></a><strong>threadlocal</strong>&nbsp;()</dt>
<dd>

321
docs/api/modules/luci.xml.html Normal file
View file

@ -0,0 +1,321 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<!-- Module list -->
<h1>Modules</h1>
<ul>
<li>
<a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
</li>
<li>
<a href="../modules/luci.http.html">luci.http</a>
</li>
<li>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>
<a href="../modules/luci.i18n.html">luci.i18n</a>
</li>
<li>
<a href="../modules/luci.ip.html">luci.ip</a>
</li>
<li>
<a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
</li>
<li>
<a href="../modules/luci.json.html">luci.json</a>
</li>
<li>
<a href="../modules/luci.jsonc.html">luci.jsonc</a>
</li>
<li>
<a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
</li>
<li>
<a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
</li>
<li>
<a href="../modules/luci.model.uci.html">luci.model.uci</a>
</li>
<li>
<a href="../modules/luci.rpcc.html">luci.rpcc</a>
</li>
<li>
<a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
</li>
<li>
<a href="../modules/luci.sys.html">luci.sys</a>
</li>
<li>
<a href="../modules/luci.sys.init.html">luci.sys.init</a>
</li>
<li>
<a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
</li>
<li>
<a href="../modules/luci.sys.net.html">luci.sys.net</a>
</li>
<li>
<a href="../modules/luci.sys.process.html">luci.sys.process</a>
</li>
<li>
<a href="../modules/luci.sys.user.html">luci.sys.user</a>
</li>
<li>
<a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
</li>
<li>
<a href="../modules/luci.util.html">luci.sys.wifi</a>
</li>
<li><strong>luci.xml</strong></li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>
<li>
<a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
</li>
<li>
<a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
</li>
<li>
<a href="../modules/nixio.File.html">nixio.File</a>
</li>
<li>
<a href="../modules/nixio.README.html">nixio.README</a>
</li>
<li>
<a href="../modules/nixio.Socket.html">nixio.Socket</a>
</li>
<li>
<a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
</li>
<li>
<a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
</li>
<li>
<a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
</li>
<li>
<a href="../modules/nixio.bin.html">nixio.bin</a>
</li>
<li>
<a href="../modules/nixio.bit.html">nixio.bit</a>
</li>
<li>
<a href="../modules/nixio.crypto.html">nixio.crypto</a>
</li>
<li>
<a href="../modules/nixio.fs.html">nixio.fs</a>
</li>
</ul>
<!-- File list -->
</div><!-- id="navigation" -->
<div id="content">
<h1>Class <code>luci.xml</code></h1>
<p></p>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#pcdata">pcdata</a>&nbsp;(value)</td>
<td class="summary">
Create valid XML PCDATA from given string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#striptags">striptags</a>&nbsp;(value)</td>
<td class="summary">
Strip HTML tags from given string.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="pcdata"></a><strong>pcdata</strong>&nbsp;(value)</dt>
<dd>
Create valid XML PCDATA from given string.
<h3>Parameters</h3>
<ul>
<li>
value: String value containing the data to escape
</li>
</ul>
<h3>Return value:</h3>
String value containing the escaped data
</dd>
<dt><a name="striptags"></a><strong>striptags</strong>&nbsp;(value)</dt>
<dd>
Strip HTML tags from given string.
<h3>Parameters</h3>
<ul>
<li>
value: String containing the HTML text
</li>
</ul>
<h3>Return value:</h3>
String with HTML tags stripped of
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

4
docs/api/modules/nixio.CHANGELOG.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.CryptoHash.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.File.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.README.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.Socket.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.TLSContext.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.TLSSocket.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.UnifiedIO.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.bin.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.bit.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.crypto.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.fs.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>

4
docs/api/modules/nixio.html
View file

@ -126,6 +126,10 @@
<a href="../modules/luci.util.html">luci.util</a>
</li>
<li>
<a href="../modules/luci.xml.html">luci.xml</a>
</li>
<li><strong>nixio</strong></li>
<li>

14
libs/luci-lib-base/luasrc/util.lua
View file

@ -159,8 +159,12 @@ end
-- String and data manipulation routines
--
-- compatibility wrapper for xml.pcdata
function pcdata(value)
return value and tparser.pcdata(tostring(value))
local xml = require "luci.xml"
perror("luci.util.pcdata() has been replaced by luci.xml.pcdata() - Please update your code.")
return xml.pcdata(value)
end
function urlencode(value)
@ -182,8 +186,12 @@ function urldecode(value, decode_plus)
return nil
end
-- compatibility wrapper for xml.striptags
function striptags(value)
return value and tparser.striptags(tostring(value))
local xml = require "luci.xml"
perror("luci.util.striptags() has been replaced by luci.xml.striptags() - Please update your code.")
return xml.striptags(value)
end
function shellquote(value)
@ -343,8 +351,6 @@ function parse_units(ustr)
end
-- also register functions above in the central string class for convenience
string.pcdata = pcdata
string.striptags = striptags
string.split = split
string.trim = trim
string.cmatch = cmatch

6
libs/luci-lib-base/luasrc/util.luadoc
View file

@ -70,10 +70,13 @@ Recursively dumps a table to stdout, useful for testing and debugging.
---[[
Create valid XML PCDATA from given string.
This is just a compatibility wrapper for luci.xml.padata()
@class function
@name pcdata
@param value String value containing the data to escape
@return String value containing the escaped data
@see luci.xml.pcdata
]]
---[[
@ -100,10 +103,13 @@ URL-encode given string.
---[[
Strip HTML tags from given string.
This is just a compatibility wrapper for luci.xml.striptags()
@class function
@name striptags
@param value String containing the HTML text
@return String with HTML tags stripped of
@see luci.xml.striptags
]]
---[[

26
modules/luci-base/luasrc/xml.lua Normal file
View file

@ -0,0 +1,26 @@
-- Copyright 2008 Steven Barth <steven@midlink.org>
-- Licensed to the public under the Apache License 2.0.
local tparser = require "luci.template.parser"
local string = require "string"
local tostring = tostring
module "luci.xml"
--
-- String and data manipulation routines
--
function pcdata(value)
return value and tparser.pcdata(tostring(value))
end
function striptags(value)
return value and tparser.striptags(tostring(value))
end
-- also register functions above in the central string class for convenience
string.pcdata = pcdata
string.striptags = striptags

23
modules/luci-base/luasrc/xml.luadoc Normal file
View file

@ -0,0 +1,23 @@
---[[
LuCI utility functions.
]]
module "luci.xml"
---[[
Create valid XML PCDATA from given string.
@class function
@name pcdata
@param value String value containing the data to escape
@return String value containing the escaped data
]]
---[[
Strip HTML tags from given string.
@class function
@name striptags
@param value String containing the HTML text
@return String with HTML tags stripped of
]]