Property:common.lua (restapi)

---

BoxMatrix >> Webinterface >> common.lua (restapi)

@ BoxMatrix   -   IRC-Chat   -   Translate: de es fr it nl pl

News

Selectors

Models

Accessories

Components

Environment

Config

Commands

System

Webif

Software

Develop

Lexicon

Community

Project

Media

---

UI-Structure

UI-Modules

HTML-Files

XML-Files

REST-API

Lua-Scripts

Javascript

Browser

SSI-Files

SSI-Directives

HTML-Text

Event-Text

Help-Pages

CSS-Files

Graphics

Research

---

Name-Collision - multiple objects in this wiki use the name common.lua! common.lua (luascr) TODO common.lua (restapi) REST-API common helper functions

---

RESTAPI-Script

RESTAPI-Script:	common.lua (restapi)   -   type Script	Wiki	Freetz	IPPF	whmf	AVM	Web
Location:	Webinterface >> RESTAPI-Scripts   -   Origin: AVM
Path:	Release: /usr/rest_api/common Lab+Rel: /usr/rest_api/common
Properties:	Size: 3.5k - 5.1k   -   Firmware: 7.70 - 8.00
Function:	REST-API common helper functions

Goto:   Functions  -  Dependencies   -   Model-Matrix   -   SMW-Browser

Details

common.lua provides REST-API common helper functions.

Being located in the common subfolder it is included by require("common.common").

REST-API:

• Lexicon: REST, API, SCGI
• Commands: scgi_server
• Ports: Port-8187-tcp
• UI-Mods: webui
• API-Root: api.lua
• Includes: api_generic.lua, rest_config.lua, security.lua, espresso.lua, rest_api_const.lua, response.lua, error.lua
• Includes: avmluamessages.lua, uimod.lua, api_generic_filter.lua, resource.lua, datatype.lua, plugin_common.lua
• Modules: storagenasrights_rest.lua, webusb_rest.lua
• Modules: calllog_rest.lua, faxjournal_rest.lua, phonebook_rest.lua, smarthome_rest.lua, boxnotify_rest.lua
• Develop: obl_fboxname.lua, dev_debug.lua, landevice.lua, query_tree.lua, fake_modules.lua, obl.lua
• Common: array.lua, common.lua, func.lua, math.lua, string.lua, table.lua, typecheck.lua, validcheck.lua
• Plugins: configflags.lua, eventlog.lua, info.lua, monitor.lua, phonebook.lua, smarthome.lua, timermix.lua
• Misc-Plugins: misc.lua, boxname.lua, configuration.lua, handsets.lua, update_status.lua, wan_status.lua
• Setup-Plugins: setup.lua

Functions

The function names of scripts often help to understand function blocks (and show gaps in the docs). fw 8.00 functions:

$ grep -e '^function' -e '^local function' /usr/rest_api/common/common.lua

# split a string by a given separator
function common.str_split (input_string, sep)

# checks for an empty json query body
function common.check_empty_body()

# adds lazy evaluation of the listed fields for the given table
function common.lazytable(tbl, getter, fields)

# converts a positive number into an array of bits. 
function common.tobits(num, length)

# require function for Lua Libs (C libraries with lua interface) with error handling
function common.require_lualib(lualib_name) 

Dependencies

Daily updated index of all dependencies of this script. Last update: GMT.
A * in the Mod column marks info from Supportdata-Probes, which will always stay incomplete.
If an Object includes itself then this is a file with the same name but another Path and the dependencies are merged.

Relation	Typ	Object	Mod	Firmware	Info	Origin
Requires	rest	response.lua	25	7.70 - 8.00	REST-API Response API	AVM
Requires	rest	rest_api_const.lua	25	7.70 - 8.00	REST-API Const Tables	AVM
Requires	rest	typecheck.lua	25	7.90 - 8.00	REST-API common internal typecheck function	AVM
Required by	rest	api.lua	25	7.70 - 8.00	REST-API Lua-Land root for scgi_server	AVM
Required by	rest	api_generic.lua	25	7.70 - 8.00	REST-API Generic Endpoints	AVM
Required by	rest	boxnotify_rest.lua	4	7.90	REST-API module for box notifications	AVM
Required by	rest	calllog_rest.lua	4	7.90	REST-API module for the Phone-Calls and TAM-Calls	AVM
Required by	rest	eventlog.lua	25	7.90 - 8.00	REST-API Plugin for the Event-Log+	AVM
Required by	rest	faxjournal_rest.lua	4	7.90	REST-API module for the Fax-Journal	AVM
Required by	rest	fiber.lua (restapi)	25	7.70 - 8.00	TODO	AVM
Required by	rest	handsets.lua	25	7.90 - 8.00	TODO	AVM
Required by	rest	internet.lua (restapi)	25	7.70 - 8.00	TODO	AVM
Required by	rest	locale.lua	25	7.70 - 8.00	TODO	AVM
Required by	rest	mesh.lua	25	7.70 - 8.00	TODO	AVM
Required by	rest	mobile.lua (restapi)	25	7.70 - 8.00	TODO	AVM
Required by	rest	myfritz.lua (restapi)	25	7.70 - 8.00	TODO	AVM
Required by	rest	opmode.lua (restapi)	25	7.70 - 8.00	TODO	AVM
Required by	rest	phonebook.lua (restapi)	25	7.90 - 8.00	REST-API Plugin for the Phonebook	AVM
Required by	rest	plugin_common.lua	25	7.90 - 8.00	REST-API Plugin helper functions	AVM
Required by	rest	privacy.lua	25	7.70 - 8.00	TODO	AVM
Required by	rest	progress.lua	25	7.70 - 8.00	TODO	AVM
Required by	rest	smarthome.lua (restapi)	19	7.90 - 8.00	REST-API Plugin for Smarthome	AVM
Required by	rest	smarthome_rest.lua	4	7.90	REST-API module for Smarthome	AVM
Required by	rest	uimod.lua (restapi)	25	7.70 - 8.00	REST-API UI-Modules API	AVM
Required by	rest	webusb_rest.lua	4	7.90	REST-API module for NAS handling	AVM
Required by	rest	wififlags.lua	25	7.70 - 8.00	TODO	AVM
26 dependencies for this script

Model-Matrix

Daily updated index of the presence, path and size of this script for each model. Last update: GMT.
Showing all models using this script. Click any column header (click-wait-click) to sort the list by the respective data.
The (main/scrpn/boot/arm/prx/atom/rtl) label in the Model column shows which CPU is meant for Multi-Linux models.
Note that this list is merged from Firmware-Probes of all known AVM firmware for a model, including Recovery.exe and Labor-Files.

Model	Firmware	Path	Size/Bytes
FRITZ!Box 4040	7.90 - 8.00	/usr/rest_api/common	5.1k
FRITZ!Box 4050	7.90	/usr/rest_api/common	5.1k
FRITZ!Box 4060	7.90	/usr/rest_api/common	5.1k
FRITZ!Box 5530 Fiber (main)	7.70 - 8.00	/usr/rest_api/common	3.5k - 5.1k
FRITZ!Box 5590 Fiber (main)	7.70 - 8.00	/usr/rest_api/common	3.5k - 5.1k
FRITZ!Box 5590 Fiber (prx)	7.70 - 8.00	/usr/rest_api/common	3.5k - 5.1k
FRITZ!Box 6591 Cable (arm)	8.00	/usr/rest_api/common	5.1k
FRITZ!Box 6591 Cable (atom)	7.90 - 8.00	/usr/rest_api/common	5.1k
FRITZ!Box 6660 Cable (arm)	7.90 - 8.00	/usr/rest_api/common	5.1k
FRITZ!Box 6660 Cable (atom)	7.90 - 8.00	/usr/rest_api/common	5.1k
FRITZ!Box 6670 Cable (arm)	7.90	/usr/rest_api/common	5.1k
FRITZ!Box 6670 Cable (atom)	7.90	/usr/rest_api/common	5.1k
FRITZ!Box 6690 Cable (arm)	7.90	/usr/rest_api/common	5.1k
FRITZ!Box 6690 Cable (atom)	7.90	/usr/rest_api/common	5.1k
FRITZ!Box 6850 LTE	7.90	/usr/rest_api/common	5.1k
FRITZ!Box 6850 5G	7.90	/usr/rest_api/common	5.1k
FRITZ!Box 7510	7.90 - 8.00	/usr/rest_api/common	5.1k
FRITZ!Box 7520	8.00	/usr/rest_api/common	5.1k
FRITZ!Box 7520 v2 (main)	7.90 - 8.00	/usr/rest_api/common	5.1k
FRITZ!Box 7530	7.90 - 8.00	/usr/rest_api/common	5.1k
FRITZ!Box 7530 AX	7.70 - 8.00	/usr/rest_api/common	3.5k - 5.1k
FRITZ!Box 7583 VDSL (main)	8.00	/usr/rest_api/common	5.1k
FRITZ!Box 7590 (main)	7.90 - 8.00	/usr/rest_api/common	5.1k
FRITZ!Box 7590 AX (main)	7.70 - 8.00	/usr/rest_api/common	3.5k - 5.1k
FRITZ!Box 7690	7.90	/usr/rest_api/common	5.1k
25 models use this script

SMW-Browser

Property:common.lua (restapi)

Information is currently being retrieved from the backend.