configuration

Configuration file for extenso.

CONFIGURATION

NAME

configuration - Configuration file for extenso.

SYNOPSIS

See Description

DESCRIPTION

Configuration file is used to initialise the program:

#
# Project name
#

Project : "v5"                                             # Name of project
WebsiteRoot : "/usr/local/website/v5"                      # Root of project
Locale : "fr_CA.utf8"                                      # Locale used in program
Postmax : "64000"                                          # Maximum number of bytes for a post

#
# Database connection
#

Database default {
        Host : "localhost"                                     # Server name
        Name : "v5"
        User : "v5"
        Password : "v5"
}

#
# List of modules
#

Module exemple {
        Library : "/usr/local/lib/libsnexemple.so"
        Init : "snexemple_init"
}


Module oauth {
        Library : "/usr/local/lib/libsnoauth.so"
        Init : "snoauth_init"
}

Module curl {
        Library : "/usr/local/lib/libsncurl.so"
        Init : "sncurl_init"
}

# Timeout in second for the request If no timeout is specified, the default value is zero which mean no timeout at all.

Timeout : "5"

#
# Preload these functions
#

Preload : "/usr/local/website/v5/permission.snc"

#
# Index file
#

Index : "index.sn"

esc_cgidata : "false"

# Timeout for a request

Timeout : "5"

The preload is used to tell apache to preload this executable file.

When a file is request by apache, this code is executed. An example:

Results:
{{
a = request();
ext = extention(a.filename);
"ext"; ext;
if ext ne "sn" && ext ne "snc" then
        "set status to -1";
        status(-1);
else
        "set status to 0";
        status(0);
endif
}}

In this case, if the extention of the file is sn or snc, the file will be parse by extenso. If not -1 is return which is the apache status DECLINED. The output of the execution is sent to error_log for debugging purpose.

PARAMETERS

esc_cgidata: If this parameter is set to "true", than all parameters when cgidata is called will be escape.; < will be replace by <, > will be replace by > and & will be replace by & Also, the original value; of a paramerer (without escaping) will be put in the name of the parameter prefix by sn_. So if the parameter is call test than cgidata.test will contain the escape value sn sn_test; will contain the original value. This parameter if valid from version 5.48 of sncode. This configuration can be overide in the function cgidata.
timeout: timeout in second before the request is stop.

AUTHOR

Written by Pierre Laplante, <laplante@sednove.com>

MODIFICATIONS

1.0 2014-09-09 21:24:14 laplante@sednove.com

1.1 2016-03-08 laplante@sednove.com Add parameter esc_cgidata and timeout

Edit

Other topics in sncode

abs

this function computes the absolute value

acos

This function computes the arc cosine of x.

acosh

This function computes the inverse hyperbolic cos of a number.

acrypt

Asymetric crypt

addslashes

Quote string with slashes.

adecrypt

Asymetric decrypt

append

is used to copy/append file

array

Functions to create and manipulate arrays

array_search

Searches a value in the array

asin

This function computes the inverse sin function of a number.

asinh

This function computes the inverse hyperbolic sine of a number.

atan

This function computes the inverse tan function of a number.

atanh

This function computes the inverse hyperbolic tan of a number.

base64_decode

Decodes data with MIME base64

base64_encode

Encodes data with MIME base64

basename

Return the file part of a pathame

bin2hex

Converts binary data into hexadecimal representation

both

Return the list of keys and values of a context.

captcha

Implement functions for captcha.

cast

Casts a value in a specific type

cbrt

This function computes the cube root of a number.

ceil

Smallest integral value not less than argument

cfunction

Describes how to add new functions in C

cgidata

parse cgidata

chr

Return a specific character

chunk_split

Split a string into smaller chunks.

clearctx

Clears a context variable entirely

clear_output

clear current buffer.

Close a file

compile

Use to compile a file.

compiler

Description of the language.

compounds

Compounds statements.

compress_html

use to compress html

config

Function config

connect

Connect to a databse

connection

Function connection

console

Output a string to error_log.

console_local

Output a string to local error_log.

contains

Checks if a value exists in an array

context

All functions about context (hash or associative array).

continue

Stop execution of a loop and continue for the next iteration.

Manage cookies.

copy

Use to copy file.

cos

This function computes the cos of a number.

cosh

This function computes the hyperbolic cos of a number.

Count_chars

Return information about characters used in a string.

Copy a file.

crc32

Calculates the crc32 polynomial of a string.

crypt

Encrypt a value with an algorythm.

crypto

Cryptographic and hashing function

Get the value for a code.

curl_easy

This function is used to request a url.

database

All functions for databases operations.

datatypes

Datatypes for extenso.

date

All functions for date operations and date functions.

datediff

Date difference

datetime

Manage date.

dbhash_close

Close a database of type key/data.

dbhash_delete

Delete

dbhash_exist

Check if a key exist in the database

dbhash_get

Return a value from the database.

dbhash_key

Return the key from the database.

dbhash_open

Open a database of type key/data.

dbhash_put

Insert a value in the database.

decrypt

Decrypt a value with an algorythm.

define

This is used to define a constant to the compiler.

delete

Delete in the databases.

deletectx

Delete an entry in a context.

delvar

Delete a variable.

dir

Use to list the file of a directory.

dirname

Return the file part of a pathame

disconnect

Disconnect to a databse

This function is used to use any characters as quotes in string

dump

Dump all variables.

Send email.

emailparse

Parse the content of an email.

end

Stop execution at this point.

erf

This computes the value obtained in the error function for a specific position.

error

Generate an error and stop execution.

err_headers_out

Display/set headers out.

esc

This function is used to apply a filter to a string.

evaluation

variables and codes.

exec

Use to exec file.

exif_read

Read exif information from a file

exist

Check for a key in an hash array

existc

Check if a class exist

existf

Check if a function exist

existm

Check if a method exist in a class

existu

Check if a user function exist

exit

Set return status code and stop.

exp

This function computes the value of e, the natural exponential, multiplied by itself x times.

exp2

This function computes the value of 2 multiplied by itself x times.

explode

Split a string by string

expm1

This function computes the value of e, the natural exponential, multiplied by itself x times, minus 1.

extenso

Description of the programming environment Extenso by Sednove.

extention

Return the length of an expression.

fabs

This function computes the absolute value of a float.

fdim

This function returns the positive difference between the 2 var chosen by the user.

filename

Return the filename.

filenames

Return the list of current filenames

files

all functions for files operations.

find_in_set

This function is used to check is a value is set within a list with a delimiter between each element.

finish

Finish execution.

first

Return first element from array.

floor

Largest integral value not greater than argument.

flush

Flush current buffer.

fmax

This function returns the biggest of the 2 var chosen by the user.

fmin

This function returns the smallest of the 2 var chosen by the user.

fonctions

Describe the use of functions within extenso

functions

Describe the use of functions within extenso

functionscall

Describe how to call a function

Functions for GD.

gd_alpha_blending

Set alpha blending in GD

gd_arc

Draw an arc.

gd_crop

Crop a GD image.

gd_ellipse

Draw an ellipse.

gd_free

Free/Relase memory for a GD structure.

gd_get_color

Return a color index.

gd_get_pixel

Get a pixel from image.

gd_get_size

Return width and height of image.

gd_line

Draw a line.

gd_merge

Merge a GD image.

gd_new

Create a new image with GD.

gd_polygon

Draw a polygon.

gd_print

Print a text in the image.

gd_resampled

Resize a GD image.

gd_resize

Resize a GD image.

gd_rotate

Rotate a GD image.

gd_save_alpha

Save Alpha in GD

gd_set_pixel

Set a pixel from image.

gd_write

Write a GD image to a file or send it to the client.

generate

Used to generate a file.

genkey

Generate a private and public key for asymetric cryptography

genpsw

genpsw number generator.

getchar

Get a character

getline

Get a line

getnbre

This function returns the number of match regular expression

getoffset

This function returns the position of the last match regular expression

getre

This function return the value of a named parameter in a regular expression.

Getting Started

Getting Started with Extenso and SNCODE

get_output

get current buffer.

get_structure

Return informations from structure.

global

Declare a global variable in a function or include.

hash

Calculate the hash of a string.

headers

Function headers

headers_out

Display/set headers out.

hex2bin

Decodes a hexadecimally encoded binary string.

hmac

Compute HMAC

How to process images with Extenso

How to resize the image after uploading

html2text

Convert html text to plain text.

htmlentities

Convert all applicable characters to HTML entities.

htmlspecialchars

Convert special characters to HTML entities.

htmlspecialchars_decode

Convert HTML entities to special characters

html_entity_decode

Convert all HTML entities to special characters

http_status

Set return status code in HTTP header.

hypot

This function computes the hypothenuse of 2 var chosen by the user.

Condition for the program.

implode

Join array elements with a string.

include

This function is used to include a file.

insert

Insert into the databse.

isalnum

This function is used to verify that the argument string contain only alphabetic and digit character.

isalpha

Checks for an alphabetic character.

isascii

Checks whether c is a 7-bit unsigned char value that fits into the ASCII character set.

isblank

Test for whitespace wide character.

iscntrl

Checks for an control character.

isdigit

Checks for a digit (0 through 9).

isfloat

Checks if the argument is a float number.

isgraph

Checks whether c is a character with graphical representation.

isinteger

Checks for a digit (0 through 9) that may be preceed by + or -.

islower

Checks for a lower-case character.

isprint

Checks for any printable character including space.

ispunct

Checks for any printable character which is not a space or an alphanumeric character.

isset

This function is used to check if a value is contained in a list with a delimiter between each element.

isspace

Checks whether c is a white-space character.

isupper

Checks for a upper-case character.

iswalnum

This function is used to verify that the argument string contain only alphabetic and digit character.

iswalpha

Checks for an alphabetic character.

iswblank

Test for whitespace wide character.

iswcntrl

Checks for an control character.

iswdigit

Checks for a digit (0 through 9).

iswgraph

Checks whether c is a character with graphical representation.

iswlower

Checks for a lower-case character.

iswprint

Checks whether c is a character with graphical representation.

iswpunct

Checks for any printable character which is not a space or an alphanumeric character.

iswspace

Checks whether c is a white-space character.

iswupper

Checks for a upper-case character.

iswxdigit

Checks for a hexadecimal digits, i.e. one of 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F.

isxdigit

Checks for a hexadecimal digits, i.e. one of 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F.

join

Join element of an array.

keys

Return the list of keys of a context.

last

Return last element from array.

lastuid

Returns last uid of an auto_increment field.

This function returns the lowercase value of a string.

lcfirst

Returns lc value of the string's first character.

length

Returns the length of an expression

levenshtein

Return the distance between 2 strings.

listc

Return an array of all class currently defined.

listf

Return an array of all system functions

listm

Return an array of all method currently defined.

listu

Return an array of all user functions

lock

Lock a file or Open and lock a file

log

This function computes the logarithm of a number.

log10

This function computes the base 10 logarithm of a number.

ltrim

Eliminates whitespace from the beginning of a string.

mail

Send email.

mails

All functions related to mail operations.

main

Describe the programming environment of Extenso

math

All functions related to math.

md5

Calculates the md5 hash of a string.

md5file

Calculate the md5 hash of a file.

mkdir

Use to create a directory.

modextenso

Module Apache for Extenso

modules

The way to implement new functions in Extenso

module_curl

money_format

Formats a number as a currency string.

Move/rename a file.

nl2br

Inserts HTML line breaks before all newlines in a string

notes

Function notes.

number_format

Formats a number as a regional number string

open

Open a file

operators

All operators in extenso.

ora_connect

Create a physical connection to an Oracle database server.

ord

Return Unicode value of character.

output

Control output.

package

Define a package in sncode

parse

Parse strings.

parsed_uri

Function parsed_uri

parse_query_string

This function is used to parse a query string.

pool

Push an existing pool or create a new one

pop

Remove last element from array and return it.

pow

This function computes the value of a var chosen by the user, multiplied by itself x times.

predefined-variables

List of predefined variables within Extenso.

preload

Function executed before handling the request.

Output a string.

printf

Print formatted text.

push

Push an element on top of array

puts

Put a string

quote

Quotation for string.

quotemeta

Quote meta characters.

random

Random number generator.

range

Generate an integer array with the range provided.

read

Read a file.

realpath

Check is a file is valid.

recaptcha

Show how to use a captcha within Extenso

redirect

Redirect current request to a new URL.

ref

Return the value of a variable

remove

Use to remove directories and files.

replace

Replace current execution file.

request

List of predefined variables within Extenso.

resub

Perform a regular expression substitute.

reverse

Reverse an array

rindex

Locate character in string (last occurence).

rint

Round to nearest integer.

rmdir

Use to remove directories.

round

Standart rounding of a number.

rtrim

Strip whitespace (or other characters) from the end of a string.

savecsv

Stores array to a file.

savexls

Export data to xls (Excel format)

seek

Move the read/write file offset to a specified byte within a file.

select

Select from the database.

sendfile

Send a file.

sessions

Implement sessions for Extenso

setlocale

Strip whitespace (or other characters) from the end of a string.

set_args

Set current args to process.

set_content_type

Set content type for the httpd server.

set_filename

Set current filename to process.

set_user

Function set_user

sha1

Calculate the sha1 hash of a string.

sha1file

Calculate the sha1 hash of a file.

shift

Remove first element from array and return it.

signal

Send sa signal

sinh

This function computes the hyperbolic sine of a number.

size

Use to size a file

sleep

Sleep for a while

Sncode from the Command Line

How to write and execute Sncode scripts from the command line

sncodeconfig

Initial configuration file for extenso.

sn_binversion

Function sn_binversion.

sn_ct

Use to implement small text within pages.

sn_source

Function sn_source

sort

Sort an array.

splice

Splice an array

split

This function is used to split a string.

splitre

This function is used to split a string with a regular expression.

sql

This function is used to do a sql request.

sqrt

This function computes the square root of a number.

stat

Use to stat a file.

static

Put a file in memory to optimize speed.

status

Set return status code.

stop

Stop execution.

strcasecmp

Case-insensitive string comparison.

strcspn

Find length of initial segment not matching mask.

strinatcmp

Case insensitive string comparisons using a natural order algorithm.

string

Functions for string manipulation

stringnify

Take an expression and return a string.

stripos

Find the position of the first occurrence of a case-insensitive substring in a string.

stripslashes

Un-quotes a quoted string

strip_tags

Strip HTML and extenso tags from a string.

strnatcmp

String comparisons using a natural order algorithm.

strncasecmp

Case-insensitive string comparison of the first n characters.

strncmp

Comparison of the first n characters.

strpos

Find the position of the first occurrence of a substring in a string.

strrev

Reverse a string

strripos

Find the position of the last occurrence of a case-insensitive substring in a string.

strrpos

Find the position of the last occurrence of a substring in a string.

strsub

return a substring from the original string.

strtr

Translate characters or replace substrings.

strtr_ctx

Translate substrings.

strtr_list

Translate substrings.

str_getcsv

Parse a CSV string into an array.

str_ireplace

Replace all occurrences of the search string with the replacement string (case insensitive).

str_pad

Pad a string to a certain length with another string.

str_repeat

Repeat a string

str_replace

Replace all occurrences of the search string with the replacement string.

str_shuffle

Randomly shuffles a string

str_split

Convert a string to an array.

subprocess_env

Function subprocess_env.

substr

Return part of a string.

switch

L'instruction switch est similaire à une série d'instructions IF sur la même expression

tail

Return last element from array.

tan

This function computes the tan of a number.

tanh

This function computes the hyperbolic tan of a number.

ternary

is an operator that takes three arguments. The arguments and result can be of different types.

tgamma

This computes the value obtained with the gamma function.

time

get current time in seconds, msecs and usecs.

timeout

Set timeout for request

top

Return first element from array.

trim

Strip whitespace (or other characters) from the end of a string.

trim2

Strip whitespace (or other characters) from the beginning and end of a string.

trunc

This function returns the nearest integer not greater in magnitude than the argument.

ttyname

Return current ttyname

twice

This function multiply a number by 2.

type

This function return the type of a variable.

This function return the uppercase value of a string.

ucfirst

Make a string's first character uppercase.

ucwords

Uppercase the first character of each word in a string.

ungetchar

Un-Get a character

unstringnify

Take a string and return an expression.

update

Update databases.

uriparse

Parse an uri and return its components.

urldecode

Decode a string.

urlencode

Encode a string.

use

Copy a variable from a parent function or a parent parser.

userfunctions

Describes user functions.

users_functions

All users functions.

utils

Utility and exception functions

uuid

Create a new unique UUID value

uuid_time

Return the time when a uuid was created.

valid

Use to validate a file or a directory.

values

Returns the list of values of a context.

virtualmachine

Description of the assembly language.

void

Discards output from an expression.

while

Used to loop.

wordwrap

Wraps a string to a given number of characters.

write

Write in a file.

wstrsub

Returns a substring from the original string.

xls

Create a new Excel file.

xml

xml functions

xmlget

A simple extractor for a XML element

xml_attr

Get attribute for current node.

xml_child

Return child for current node.

xml_content

Read the value of a node, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). Entity references are substituted.

xml_each

Return or loop threw all children of current node.

xml_free

Free an xml structure.

xml_has_child

Check if the current node has child.

xml_name

Get the name of the current element in xml structure.

xml_nbchild

Return number of child for current node.

xml_new

Initialise xml with a new xml.