summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Dittberner <jan+github@dittberner.info>2018-11-14 20:33:06 +0100
committerGitHub <noreply@github.com>2018-11-14 20:33:06 +0100
commit6d09afec553dc20c665445ddfbfa0ee7cb003212 (patch)
tree791f949b276369c76800f268a4412f5ea8553c39
parenta82c617c1bbdfbc6cb5fa9287c751327e77160e3 (diff)
parent4d8344f1380f13d92086f4bd0a3fb022739d46a6 (diff)
downloadcacert-codedocs-6d09afec553dc20c665445ddfbfa0ee7cb003212.tar.gz
cacert-codedocs-6d09afec553dc20c665445ddfbfa0ee7cb003212.tar.xz
cacert-codedocs-6d09afec553dc20c665445ddfbfa0ee7cb003212.zip
Merge pull request #1 from GuKKDevel/GuKKDevel
Gukk devel
-rw-r--r--help-files/PARAM-files11
-rw-r--r--help-files/PROGRAM-files6
-rw-r--r--source/DIR-includes.rst380
-rw-r--r--source/DIR-pages.rst4
-rw-r--r--source/DIR-www.rst15
5 files changed, 413 insertions, 3 deletions
diff --git a/help-files/PARAM-files b/help-files/PARAM-files
new file mode 100644
index 0000000..0adf58b
--- /dev/null
+++ b/help-files/PARAM-files
@@ -0,0 +1,11 @@
+/includes/mysql.php configs:
+
+$_SESSION['mconn'] = TRUE;
+$_SESSION['_config']['normalhostname'] = "www.cacert.org";
+$_SESSION['_config']['securehostname'] = "secure.cacert.org";
+$_SESSION['_config']['tverify'] = "tverify.cacert.org";
+
+
+/includes/general.php
+
+$_SESSION['_config']['filepath']
diff --git a/help-files/PROGRAM-files b/help-files/PROGRAM-files
new file mode 100644
index 0000000..6da47aa
--- /dev/null
+++ b/help-files/PROGRAM-files
@@ -0,0 +1,6 @@
+check_email_exists includes/notary.inc.php
+csrf_check includes/general.php
+loadem includes/general.php
+sendmail includes/mysql.php
+showfooter includes/account_stuff.php
+showheader includes/account_stuff.php
diff --git a/source/DIR-includes.rst b/source/DIR-includes.rst
index 85882c3..be43d1a 100644
--- a/source/DIR-includes.rst
+++ b/source/DIR-includes.rst
@@ -36,10 +36,85 @@ Directory :file:`includes`
.. sourcefile:: includes/account_stuff.php
+ :file:`includes/account_stuff.php` provides two procedures to be used for building the output of some HTML-pages.
+
+ .. php:function:: showheader($title = "CAcert.org", $title2 = "")
+
+ This function renders a page depending on the calling file. It is expected that only files
+
+ www/wot.php (web-of-trust),
+
+ www/gpg.php (gpg-key),
+
+ www/disputes.php (disputes) and
+
+ www/advertising.php (advertising)
+
+ are using this function.
+
+ :param string $title:
+ :param string $title2:
+ :global: * *(int)* - $id:
+ :global: * *(string)* - $PHP_SELF:
+
+ .. php:function:: showfooter()
+
+ This function renders a page-footer.
+
+
.. sourcefile:: includes/account.php
- :uses:
- includes/about_menu.php
- .... showheader
+ :uses:
+ includes/loggedin.php
+ includes/lib/l10n.php
+ includes/lib/check_weak_key.php
+ includes/notary.inc.php
+ includes/general.php
+ includes/account_stuff.php
+ includes/notary.inc.php
+ SOME__sanitizeHTML
+ .. ?-check_email
+ .. ?-make_hash
+ includes/mysql.php__sendmail
+ .. ?-account_email_delete
+ .. ?-checkWeakKeySPKAC
+ .. ?-write_user_agreement
+ .. ?-generatecertpath
+ .. ?-checkWeakKeyCSR
+ .. ?-waitForResult
+ .. ?-checkEmail
+ .. ?-account_domain_delete
+ .. ?-clean_csr
+ .. ?-extractit
+ .. ?-getcn
+ .. ?-getalt
+ .. ?-HashAlgorithms::clean_csr
+ .. ?-checkWeakKeyX509
+ .. ?-unset
+ .. ?-valid_ticket_number
+ .. ?-write_se_log
+ .. ?-revoke_all_private_cert
+ .. ?-runCommand
+ .. ?-check_client_cert_running
+ .. ?-check_server_cert_running
+ .. ?-check_gpg_cert_running
+ .. ?-check_is_orgadmin
+ .. ?-account_delete
+
+
+
+ .. php:function:: buildSubject(array $domains, $include_xmpp_addr = true)
+
+ Build a subject string as needed by the signer
+
+ :param array(string) $domains: First domain is used as CN and repeated in subjectAltName. Duplicates should already been removed
+ :param bool $include_xmpp_addr: [default: true] Whether to include the XmppAddr in the subjectAltName. This is needed if the Jabber server is jabber.example.com but a Jabber ID on that server would be alice@example.com
+ :return: * (string) - subject string as needed by the signer
+
+ .. php:function:: buildSubjectFromSession()
+
+ Builds the subject string from the session variables $_SESSION['_config']['rows'] and $_SESSION['_config']['altrows']
+
+ :return: * (string) -
.. sourcefile:: includes/general_stuff.php
@@ -95,6 +170,305 @@ Directory :file:`includes`
.. sourcefile:: includes/notary.inc.php
+ :file:`includes/notary.inc.php` provides a set of funktions; here listed in the given order:
+
+ .. php:function:: query_init ($query)
+
+ Accesss the database to execute the passed query.
+
+ :param string $query: query to execute
+ :return: * (resource) - result of the passed query.
+
+ .. php:function:: query_getnextrow ($res)
+
+ Return the next row of a previous received result of a database query.
+
+ :param resource $res: Result of a previous database query.
+ :return: * (object) - next row in the passed resource
+
+ .. php:function:: query_get_number_of_rows ($resultset)
+
+ Return the number of rows of the passed $resource which has to be the result of a previous database query, select-statement
+
+ :param resource $resultset: Result of a previous database query
+ :return: * (int) - number of rows in the passed resource
+
+ .. php:function:: get_number_of_assurances ($userid)
+
+ Returns the number of assurances the user with the passed userid has given.
+
+ :param int $userid: userid of be controled
+ :return: * (int) - number of given assurances
+
+ .. php:function:: get_number_of_ttpassurances ($userid)
+
+ Returns the number of TTP-assurances the user with the passed userid has received.
+
+ :param int $userid: userid of be controled
+ :return: * (int) - number of received TTP-assurances
+
+ .. php:function:: get_number_of_assurees ($userid)
+
+ Returns the number of assurances the user with the passed userid has received.
+
+ :param int $userid: userid of be controled
+ :return: * (int) - number of received assurances
+
+ .. php:function:: get_top_assurer_position ($no_of_assurances)
+
+ Returns the ranking of an assurer with the passed number of given assurances.
+
+ :param int $no_of_assurances: number of assurances
+ :return: * (int) - position at the list of top assurers
+
+ .. php:function:: get_top_assuree_position ($no_of_assurees)
+
+ Returns the ranking of an assuree with the passed number of received assurances.
+
+ :param int $no_of_assurances: number of assurances
+ :return: * (int) - position at the list of top assurees
+
+ .. php:function:: get_given_assurances($userid, $log=0)
+
+ Get the list of assurances given by the user
+
+ :param int $userid: id of the assurer
+ :param int $log: if set to 1 also includes deleted assurances
+ :return: * (resource) - a MySQL result set
+
+ .. php:function:: get_received_assurances($userid, $log=0)
+
+ Get the list of assurances received by the user
+
+ :param int $userid: id of the assuree
+ :param int $log: if set to 1 also includes deleted assurances
+ :return: * (resource) - a MySQL result set
+
+ .. php:function:: get_given_assurances_summary ($userid)
+
+ Get the count of given assurances of the user with the passed userid grouped by points, awarded, method
+
+ :param int $userid: id of the assurer
+ :return: * (resource) - list of number of given assurances grouped by points, awarded, method
+
+ .. php:function:: get_received_assurances_summary ($userid)
+
+ Get the count of received assurances of the user with the passed userid grouped by points, awarded, method
+
+ :param int $userid: id of the assuree
+ :return: * (resource) - list of number of received assurances grouped by points, awarded, method
+
+ .. php:function:: get_user ($userid)
+
+ Get data of user with the passed userid.
+
+ :param int $userid: id of the user
+ :return: * (resource) - data frum table users belonging to passed userid.
+
+ .. php:function:: get_cats_state ($userid)
+
+ Get the number of passed CATS for the given userid.
+
+ :param int $userid: id of a user
+ :return: * (int) - number of passed CATS
+
+ .. php:function:: calc_awarded($row)
+
+ Calculate awarded points (corrects some issues like out of range points or points that were issued by means that have been deprecated)
+
+ :param array $row: associative array containing the data from the `notary` table
+ :return: * (int) - the awarded points for this assurance
+
+ .. php:function:: calc_experience(&$row, &$sum_points, &$sum_experience)
+
+ Calculate the experience points from a given Assurance.
+
+ :param array $row: [inout] associative array containing the data from the `notary` table, the keys 'experience' and 'calc_awarded' will be added
+ :param int $sum_points: [inout] the sum of already counted assurance points the assurer issued
+ :param int $sum_experience: [inout] the sum of already counted experience points that were awarded to the assurer
+
+ .. php:function:: calc_assurances(&$row, &$sum_points, &$sum_experience)
+
+ Calculate the points received from a received Assurance.
+
+ :param array $row: [inout] associative array containing the data from the `notary` table, the keys 'experience' and 'calc_awarded' will be added
+ :param int $sum_points: [inout] the sum of already counted assurance points the assuree received
+ :param int $sum_experience: [inout] the sum of already counted experience points that were awarded to the assurer
+
+ .. php:function:: show_user_link($user)
+
+ Generate a link to the support engineer page for the user with the name of the user as link text
+
+ :param array $user: associative array containing the data from the `user` table
+ :return: * (string) - name of the user with the passed userid or System or deleted
+
+ .. php:function:: show_email_link($user)
+
+ Generate a link to the support engineer page for the user with the email address as link text
+
+ :param array $user: associative array containing the data from the `user` table
+ :return: * (string) - email-address
+
+ .. php:function:: get_assurer_ranking($userid,&$num_of_assurances,&$rank_of_assurer)
+
+ Getting the number of given assurances and the rank of the user with the passed userid.
+
+ :param int $userid: id of an user
+ :param int $num_of_assurances: [inout] number of given assurances
+ :param int $rank_of_assurer: [inout] rank in assurer-list
+
+ .. php:function:: get_assuree_ranking($userid,&$num_of_assurees,&$rank_of_assuree)
+
+ Getting the number of received assurances and the rank of the user with the passed userid.
+
+ :param int $userid: id of an user
+ :param int $num_of_assurees: [inout] number of received assurances
+ :param int $rank_of_assuree: [inout] rank in assuree-list
+
+ .. php:function:: output_ranking($userid)
+
+ Generating HTML-code for showing the assurer/assuree data
+
+ :param int $userid: userid to build the page format
+
+ .. php:function:: output_assurances_header($title, $support, $log)
+
+ Render header for the assurance table (same for given/received)
+
+ :param string $title: The title for the table
+ :param int $support: set to 1 if the output is for the support interface
+ :param int $log: if set to 1 also includes deleted assurances
+
+ .. php:function:: output_assurances_footer($points_txt,$sumpoints,$experience_txt,$sumexperience,$support,$log)
+
+ Render footer for the assurance table (same for given/received)
+
+ :param string $points_txt: Description for sum of assurance points
+ :param int $sumpoints: sum of assurance points
+ :param string $experience_txt: Description for sum of experience points
+ :param int $sumexperience: sum of experience points
+ :param int $support: set to 1 if the output is for the support interface
+ :param int $log: if set to 1 also includes deleted assurances
+
+ .. php:function:: output_assurances_row($assurance,$userid,$other_user,$support,$ticketno,$log)
+
+ Render an assurance for a view
+
+ :param array $assurance: associative array containing the data from the `notary` table
+ :param int $userid: Id of the user whichs given/received assurances are displayed
+ :param array $other_user: associative array containing the other users data from the `users` table
+ :param int $support: set to 1 if the output is for the support interface
+ :param string $ticketno: ticket number currently set in the support interface
+ :param int $log: if set to 1 also includes deleted assurances
+
+ .. php:function:: output_summary_header()
+
+ Render the header for the summary.
+
+ .. php:function:: output_summary_footer()
+
+ Render the footer for the summary.
+
+ .. php:function:: output_summary_row($title,$points,$points_countable,$remark)
+
+ Render a row of the summary of points
+
+ :param string $title: The description of the row
+ :param inf $points:
+ :param int $points_countable:
+ :param string $remark:
+
+ .. todo:: check points and points_countable
+
+ .. php:function:: output_given_assurances_content($userid,&$sum_points,&$sum_experience,$support,$ticketno,$log)
+
+ Helper function to render assurances given by the user
+
+ :param int $userid: id of a user
+ :param int &$sum_points: [out] sum of given points
+ :param int &$sum_experience: [out] sum of experience points gained
+ :param int $support: set to 1 if the output is for the support interface
+ :param string $ticketno: the ticket number set in the support interface
+ :param int $log: if set to 1 also includes deleted assurances
+
+ .. php:function:: output_received_assurances_content($userid,&$sum_points,&$sum_experience,$support,$ticketno,$log)
+
+ Helper function to render assurances received by the user
+
+ :param int $userid: id of a user
+ :param int& $sum_points: [out] sum of received points
+ :param int& $sum_experience: [out] sum of experience points the assurers gained
+ :param int $support: set to 1 if the output is for the support interface
+ :param string $ticketno: the ticket number set in the support interface
+ :param int $log: if set to 1 also includes deleted assurances
+
+ .. php:function:: check_date_limit ($userid,$age)
+
+ Checks if the user with the passed userid has reached a given age.
+
+ :param int $userid: id of a user
+ :param int $age: the age to be checked against
+ :return: * (int) - 1: if the given age is reached; 0 else
+
+ .. php:function:: max_points($userid)
+
+ Determin, how many points the user can issue at most.
+
+ :param int $userid: id of a user
+ :return: * (int) - max to issue points
+
+ .. php:function:: output_summary_content($userid,$display_output)
+
+ Calculate points and render them for output.
+
+ :param int $userid: id of a user
+ :param int $display_output: flag if to display (1) or not (0)
+ :retur: * (int) - max to issue points
+
+ .. php:function:: output_given_assurances($userid, $support=0, $ticketno='', $log=0)
+
+ Render assurances given by the user
+
+ :param int $userid:
+ :param int $support: set to 1 if the output is for the support interface
+ :param string $ticketno: the ticket number set in the support interface
+ :param int $log: if set to 1 also includes deleted assurances
+
+ .. php:function:: output_received_assurances($userid, $support=0, $ticketno='', $log=0)
+
+ Render assurances received by the user
+
+ :param int $userid:
+ :param int $support: set to 1 if the output is for the support interface
+ :param string $ticketno: the ticket number set in the support interface
+ :param int $log: if set to 1 also includes deleted assurances
+
+ .. php:function:: output_summary($userid)
+
+ Render the page output for a user.
+
+ :param int $userid:
+
+ .. todo:: more documentation from line 833 on
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
.. sourcefile:: includes/shutdown.php
.. sourcefile:: includes/sponsorinfo.php
diff --git a/source/DIR-pages.rst b/source/DIR-pages.rst
index a3240a2..6ebed43 100644
--- a/source/DIR-pages.rst
+++ b/source/DIR-pages.rst
@@ -238,6 +238,10 @@ Directory :file:`pages/index`
.. sourcefile:: pages/index/19.php
+.. sourcefile:: pages/index/20.php
+
+ The file :file:`pages/index/20.php` doesn't exist but is linked to.
+
.. sourcefile:: pages/index/21.php
.. sourcefile:: pages/index/47.php
diff --git a/source/DIR-www.rst b/source/DIR-www.rst
index 2a1f51a..ad3c70d 100644
--- a/source/DIR-www.rst
+++ b/source/DIR-www.rst
@@ -44,6 +44,21 @@ This contains the PHP code that is the entry point to the application:
.. sourcefile:: www/.htaccess
.. sourcefile:: www/index.php
+ :uses:
+ includes/lib/l10n.php
+ includes/notary.inc.php
+ pages/index/17.php
+ pages/index/20.php
+ includes/general.php-loadem
+ incledes/mysql.php-sendmail
+ includes/general.php-checkpw
+
+ The :file:`index.php` is the main page of the CAcert website. Depending on an id transfered to this module different actions are performed.
+
+ ids
+
+.. todo:: Check where/when includes/general.php and includes/mysql.php is loaded
+
.. sourcefile:: www/keygenIE.js