Split directories.rst into per directory files
[cacert-codedocs.git] / source / DIR-includes.rst
1 .. index:: includes
2 .. index:: PHP
3
4 ==========================
5 Directory :file:`includes`
6 ==========================
7
8 .. sourcefile:: includes/.cvsignore
9
10 :file:`.cvsignore` includes the parameters for CVS, which files to ignore by
11 versioning
12
13 .. note:: CVS is long dead, is this still used?
14
15 .. sourcefile:: includes/.gitignore
16
17 :file:`.gitignore` contains file patterns to be ignored by Git.
18
19 .. sourcefile:: includes/about_menu.php
20 :links:
21 http://blog.cacert.org/
22 http://wiki.CAcert.org/
23 www/policy/
24 //wiki.cacert.org/FAQ/Privileges
25 www/index.php?id=47
26 www/logos.php
27 www/stats.php
28 http://blog.CAcert.org/feed/
29 www/index.php?id=7
30 //wiki.cacert.org/Board
31 https://lists.cacert.org/wws
32 www/src-lic.php
33
34 :file:`about_menu.php` is a part (<div>) of a PHP-Page, containing most of
35 the CAcert-related links.
36
37 .. sourcefile:: includes/account_stuff.php
38
39 .. sourcefile:: includes/account.php
40 :uses:
41 includes/about_menu.php
42 .... showheader
43
44 .. sourcefile:: includes/general_stuff.php
45
46 .. sourcefile:: includes/general.php
47
48 .. sourcefile:: includes/keygen.php
49
50 .. sourcefile:: includes/loggedin.php
51
52 .. sourcefile:: includes/mysql.php
53
54 :file:`includes/mysql.php` is not contained in the :cacertgit:`cacert-devel`
55 repository but is used by several other files. The file is copied from
56 :sourcefile:`includes/mysql.php.sample` and defines the database connection
57 information.
58
59 This file is parsed directly by :sourcefile:`CommModule/client.pl`
60 format changes might break the CommModule code.
61
62 .. sourcefile:: includes/mysql.php.sample
63
64 :file:`mysql.php.sample` is a template for the database connection handling
65 code that is meant to be copied to :file:`mysql.php`.
66
67 The template defines the MySQL connection as a session variable `mconn` and
68 tries to connect to that database. It also defines the session variables
69 `normalhostname`, `securehostname` and `tverify`.
70
71 The template defines a function :php:func:`sendmail` for sending mails.
72
73 .. php:function:: sendmail($to, $subject, $message, $from, $replyto="", \
74 $toname="", $fromname="", $errorsto="returns@cacert.org", \
75 $use_utf8=true)
76
77 Send an email. The function reimplements functionality that is readily
78 available in PHP. The function does not properly escape headers and
79 sends raw SMTP commands.
80
81 :param string $to: recipient email address
82 :param string $subject: subject
83 :param string $message: email body
84 :param string $from: from email address
85 :param string $replyto: reply-to email address
86 :param string $fromname: unused in the code
87 :param string $toname: unused in the code
88 :param string $errorsto: email address used for Sender and Errors-To
89 headers
90 :param bool $use_utf8: decides whether the Content-Type header uses
91 a charset parameter of utf-8 or iso-8859-1
92
93 Configuration and actual code are mixed. It would be better to have a
94 separate file that just includes configuration.
95
96 .. sourcefile:: includes/notary.inc.php
97
98 .. sourcefile:: includes/shutdown.php
99
100 .. sourcefile:: includes/sponsorinfo.php
101
102 .. sourcefile:: includes/tverify_stuff.php
103
104
105 .. index:: includes/lib
106 .. index:: PHP
107
108 Directory :file:`includes/lib`
109 ==============================
110
111 .. sourcefile:: includes/lib/account.php
112
113 .. sourcefile:: includes/lib/check_weak_key.php
114
115 .. sourcefile:: includes/lib/general.php
116
117 .. sourcefile:: includes/lib/l10n.php