system Namespace Reference

Namespaces
namespace	file
namespace	group
namespace	loginattempt
namespace	newuser
namespace	page
namespace	session
namespace	user

Functions
def	controlpanelapi (g)
	Configures settings for the whole site. More...
def	dbapi (g)
	Used by the web database management interface to handle objects in the system. More...
def	fileapi (g)
	Standard API to search through the files on the system and change names or descriptions. More...
def	securityapi (g)
	Sets security for database objects. More...
def	sessionvars (g)
	In order to enable caching for static pages, we place all session and user specific information in this special handler. More...
def	translationsapi (g)
	Handles frequently used translations for the system. More...
def	upload (g)
	Handles uploads for the whole system. More...
def	userapi (g)
	Handles logins, registrations, approvals, and user information. More...

Variables
dictionary	ROUTES

Function Documentation

controlpanelapi()

def system.controlpanelapi

(

g

)

Configures settings for the whole site.

You must be an administrator in order to see and change settings.

Definition at line 856 of file __init__.py.

dbapi()

def system.dbapi

(

g

)

Used by the web database management interface to handle objects in the system.

You must be an administrator to use this API.

Definition at line 936 of file __init__.py.

fileapi()

def system.fileapi

(

g

)

Standard API to search through the files on the system and change names or descriptions.

Note that files are one of the few objects where security is enabled by default, so we rely on the system security protection to block unauthorized access.

Definition at line 71 of file __init__.py.

securityapi()

def system.securityapi

(

g

)

Sets security for database objects.

Note that the DB_SECURE flag must be set on both the database and the model in order to apply.

Definition at line 1334 of file __init__.py.

sessionvars()

def system.sessionvars

(

g

)

In order to enable caching for static pages, we place all session and user specific information in this special handler.

Using this technique, we can use nginx to rapidly serve static files while this function only has minimal work to do.

Definition at line 33 of file __init__.py.

translationsapi()

def system.translationsapi

(

g

)

Handles frequently used translations for the system.

You must be an administrator or be part of the translators group in order to use this API.

Definition at line 1209 of file __init__.py.

upload()

def system.upload

(

g

)

Handles uploads for the whole system.

Files in Pafera are stored under their shortcodes, and can be private or public. Note that you'll need ImageMagick and ffmpegthumbnailer installed on your system for automatic thumbnail generation.

Definition at line 216 of file __init__.py.

userapi()

def system.userapi

(

g

)

Handles logins, registrations, approvals, and user information.

Also handles adding friends, following other users, and so forth.

Note that normal users cannot search for other users. You must be an administrator or have managed users assigned to you in order to see and change other users.

Definition at line 335 of file __init__.py.

Variable Documentation

ROUTES

dictionary system.ROUTES

Initial value:

=  {
  'fileapi':          fileapi,
  'upload':           upload,
  'controlpanelapi':  controlpanelapi,
  'dbapi':            dbapi,
  'userapi':          userapi,
  'sessionvars':      sessionvars,
  'translationsapi':  translationsapi,
  'securityapi':      securityapi,
}

Definition at line 1585 of file __init__.py.