cacert-codedocs/source/DIR-includes.rst

includes

PHP

Directory includes

includes/.cvsignore

.cvsignore includes the parameters for CVS, which files to ignore by versioning

Note

CVS is long dead, is this still used?

includes/.gitignore

.gitignore contains file patterns to be ignored by Git.

includes/about_menu.php

links

"http://blog.cacert.org/"

"http://blog.CAcert.org/feed/"

"http://bugs.CAcert.org/"

"https://lists.cacert.org/wws"

"http://wiki.CAcert.org/"

"http://wiki.cacert.org/Board"

"http://wiki.cacert.org/FAQ/Privileges"

"www/policy/"

"www/src-lic.php"

about_menu.php is a part (<div>) of a PHP-Page, containing most of the CAcert-related links. It uses :php$_SESSION['mconn']

includes/account_stuff.php

uses

includes/about_menu.php

includes/account_stuff.php provides two procedures to be used for building the output of some HTML-pages.

It uses the global variables: :php$_REQUEST['id']

includes/account.php

includes/general_stuff.php

includes/general.php

includes/keygen.php

includes/loggedin.php

includes/mysql.php

includes/mysql.php is not contained in the cacert-devel repository but is used by several other files. The file is copied from includes/mysql.php.sample and defines the database connection information.

This file is parsed directly by CommModule/client.pl format changes might break the CommModule code.

includes/mysql.php.sample

mysql.php.sample is a template for the database connection handling code that is meant to be copied to mysql.php.

The template defines the MySQL connection as a session variable :php$_SESSION['mconn'] while connecting to that database. It also defines the session variables :php$_SESSION['_config']['normalhostname'], :php$_SESSION['_config']['securehostname'] and :php$_SESSION['_config']['tverify'].

The template defines a function :phpsendmail for sending mails.

Configuration and actual code are mixed. It would be better to have a separate file that just includes configuration.

includes/notary.inc.php

includes/notary.inc.php defines the global constants :phpNULL_DATETIME and :phpTHAWTE_REVOCATION_DATETIME. It also provides a set of funktions; here listed in the given order:

check points and points_countable

includes/shutdown.php

includes/sponsorinfo.php

includes/tverify_stuff.php

includes/lib

PHP

Directory includes/lib

includes/lib/account.php

include/lib/account.php defines a function and a class for use by other precedures.

includes/lib/check_weak_key.php

uses

includes/lib/general.php

includes/lib/check_weak_key.php does the checking of keys for vulnaribilities and therefore provides some functions to be used by other procedures.

includes/lib/general.php

includes/lib/general.php provides the system with four functions.

includes/lib/l10n.php

includes/lib/l10n.php defines the class L10n. Some methods use and manipulate the global variables: