ACF Libraries

Because of using lua, a very small language, the need arises to build everything from scratch. This can lead to some confusion, apprehension, or just feeling overwhelmed. Here is documentation on what we have now in the form of libraries and common functions. We hope to build some more and use this information to get the juices flowing in regard to ACF.

Some of these are lua libs or ones written for ACF. We are also using as a standard the lposix library which is documented here LPOSIX

apk.lua

Functions to load/unload apk packages

repository
get_all
get_loaded
get_available
delete
install
is_installed

authenticator.lua

Authentication module

authenticate
get_userinfo
get_userinfo_roles
list_users
change_settings
new_settings
delete_user
list_userfields
read_userfield
delete_userfield
write_userentry
read_userentry
delete_userentry
list_rolefields
read_rolefield
delete_rolefield
write_roleentry
read_roleentry
delete_roleentry

authenticator-plaintext.lua

Authentication sub-module for plaintext database

list_fields
read_field
delete_field
write_entry
read_entry
delete_entry

controllerfunctions.lua

Controller helper functions

handle_clientdata
handle_form
handle_startstop

date.lua

Date and time functions To be used with os.time() and os.date()

date_to_seconds - Takes a date table and converts it to seconds from 1970
seconds_to_date - Takes table of seconds values and converts to a date sorted smallest to largest
string_to_table
date_diff - Takes two values of seconds and gives back the difference
num_month_name - Month number to name of month
num_month_name_abr - Month number to abr of month
name_month_num - Month name to number
abr_month_num - Month abbreviation to number
num_dow_name - Day of Week number to name
num_dow_name_abr - Day of week number to abbreviation
name_dow_num - Day of Week full name to number
abr_dow_num - Day of week abbreviation to number
what_tz - Checks to see what timezone the box is set to; /etc/TZ
change_tz - Changes the timezone
- Tables are included with this information
  - Timezones
  - Days of Week
  - Months of the Year

format.lua

Used to format tables and strings

dostounix - converts dos line endings to unix
parse_lines - takes out the blank and commented lines
parse_linesandwords
parse_configfile
search_replace - will go through a file or table and search and replace
search_for_lines - will go through a file and return a table with matches
cap_begin_word - will capitalize beginning of words
string_to_table - takes a delimited string and turns it into a table
md5sum_string
expand_bash_syntax_vars
replace_line
insert_line
get_line
opts_to_table
table_to_opts
update_configfile2
parse_configfile2
get_section
set_section

fs.lua

Used for various filesystem specific functions

is_dir - test if the path is a directory
is_file - test if the path is a file
is_link - test if the path is a link
create_file
read_file / read_file_as_array - will read a file as a string / array
write_file - replace contents of a file
write_line_file - appends lines to a file
md5sum_file - give a hash, md5sum of a file
find - Give a path and a search string and iterate over matching files
stat

html.lua

Functions used by web_elements.lua. Written by nangel for ACF.

cookie.set -creates a cookie to be used with ACF
cookie.unset
html_escape - will escape html encoded strings
entity
link
cfe_unpack - returns the whole of a cfe as a string. Great for troubleshooting.
Form setup functions - also are the "types" of cfe. See ACF_core_principles
- form.text
- form.longtext
- form.password
- form.hidden
- form.submit
- form.action
- form.file
- form.image
- form.select
- form.checkbox
- form.start
- form.stop