Fix formatting and add documentation

- mod/register
- mod/regmod
- Model/User
- Worker/CronJobs

diff --git a/mod/register.php b/mod/register.php
index cd6385144cd21e660b13327d073b60f136357160..8645ecb9ce28b5904aef55049dc4e90a9019aa93 100644 (file)
--- a/mod/register.php
+++ b/mod/register.php
@@ -6,9 +6,9 @@ use Friendica\Core\PConfig;
 use Friendica\Core\System;
 use Friendica\Core\Worker;
 
-require_once('include/enotify.php');
-require_once('include/bbcode.php');
 require_once('include/user.php');
+require_once 'include/enotify.php';
+require_once 'include/bbcode.php';
 
 if(! function_exists('register_post')) {
 function register_post(App $a) {

diff --git a/mod/regmod.php b/mod/regmod.php
index 6d76e7ea7eb7f8814d892283ace04fa144782aac..7fce6914f2f17ae5f94a34f96783a968d3148291 100644 (file)
--- a/mod/regmod.php
+++ b/mod/regmod.php
@@ -6,11 +6,12 @@ use Friendica\Core\System;
 use Friendica\Core\Worker;
 use Friendica\Database\DBM;
 
-require_once('include/enotify.php');
 require_once('include/user.php');
 
-function user_allow($hash) {
+require_once 'include/enotify.php';
 
+function user_allow($hash)
+{
        $a = get_app();
 
        $register = q("SELECT * FROM `register` WHERE `hash` = '%s' LIMIT 1",
@@ -18,7 +19,7 @@ function user_allow($hash) {
        );
 
 
-       if (! DBM::is_result($register)) {
+       if (!DBM::is_result($register)) {
                return false;
        }
 
@@ -26,7 +27,7 @@ function user_allow($hash) {
                intval($register[0]['uid'])
        );
 
-       if (! DBM::is_result($user)) {
+       if (!DBM::is_result($user)) {
                killme();
        }
 
@@ -44,7 +45,7 @@ function user_allow($hash) {
        );
        if (DBM::is_result($r) && $r[0]['net-publish']) {
                $url = System::baseUrl() . '/profile/' . $user[0]['nickname'];
-               if ($url && strlen(Config::get('system','directory'))) {
+               if ($url && strlen(Config::get('system', 'directory'))) {
                        Worker::add(PRIORITY_LOW, "Directory", $url);
                }
        }
@@ -60,20 +61,17 @@ function user_allow($hash) {
 
        pop_lang();
 
-       if($res) {
-               info( t('Account approved.') . EOL );
+       if ($res) {
+               info(t('Account approved.') . EOL);
                return true;
        }
-
 }
 
-
 // This does not have to go through user_remove() and save the nickname
 // permanently against re-registration, as the person was not yet
 // allowed to have friends on this system
-
-function user_deny($hash) {
-
+function user_deny($hash)
+{
        $register = q("SELECT * FROM `register` WHERE `hash` = '%s' LIMIT 1",
                dbesc($hash)
        );
@@ -91,23 +89,22 @@ function user_deny($hash) {
 
        notice(sprintf(t('Registration revoked for %s'), $user[0]['username']) . EOL);
        return true;
-
 }
 
-function regmod_content(App $a) {
-
+function regmod_content(App $a)
+{
        global $lang;
 
        $_SESSION['return_url'] = $a->cmd;
 
-       if (! local_user()) {
-               info( t('Please login.') . EOL);
+       if (!local_user()) {
+               info(t('Please login.') . EOL);
                $o .= '<br /><br />' . login(($a->config['register_policy'] == REGISTER_CLOSED) ? 0 : 1);
                return $o;
        }
 
-       if ((!is_site_admin()) || (x($_SESSION,'submanage') && intval($_SESSION['submanage']))) {
-               notice( t('Permission denied.') . EOL);
+       if ((!is_site_admin()) || (x($_SESSION, 'submanage') && intval($_SESSION['submanage']))) {
+               notice(t('Permission denied.') . EOL);
                return '';
        }
 
@@ -115,20 +112,18 @@ function regmod_content(App $a) {
                killme();
        }
 
-       $cmd  = $a->argv[1];
+       $cmd = $a->argv[1];
        $hash = $a->argv[2];
 
-
-
        if ($cmd === 'deny') {
                user_deny($hash);
-               goaway(System::baseUrl()."/admin/users/");
+               goaway(System::baseUrl() . "/admin/users/");
                killme();
        }
 
        if ($cmd === 'allow') {
                user_allow($hash);
-               goaway(System::baseUrl()."/admin/users/");
+               goaway(System::baseUrl() . "/admin/users/");
                killme();
        }
 }

diff --git a/src/Model/User.php b/src/Model/User.php
index b2beb8e19b7a6fe49efcf290ab1395fa121cbe43..398cd19b428c14823621749aafbff2fedbc9b87b 100644 (file)
--- a/src/Model/User.php
+++ b/src/Model/User.php
@@ -20,6 +20,19 @@ require_once 'include/plugin.php';
  */
 class User
 {
+       /**
+        * @brief Authenticate a user with a clear text password
+        *
+        * User info can be any of the following:
+        * - User DB object
+        * - User Id
+        * - User email or username or nickname
+        * - User array with at least the uid and the hashed password
+        *
+        * @param mixed $user_info
+        * @param string $password
+        * @return boolean
+        */
        public static function authenticate($user_info, $password)
        {
                if (is_object($user_info)) {

diff --git a/src/Worker/CronJobs.php b/src/Worker/CronJobs.php
index cbfa86ed88773e9b15e0ca6328a4a3970d3655f9..a59cd4f9f1b6e1970370efd45023fe51912d5e07 100644 (file)
--- a/src/Worker/CronJobs.php
+++ b/src/Worker/CronJobs.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file src/worker/CronJobs.php
  */
@@ -14,22 +15,23 @@ use Friendica\Network\Probe;
 use Friendica\Protocol\PortableContact;
 use dba;
 
-class CronJobs {
-       public static function execute($command = ''){
+class CronJobs
+{
+       public static function execute($command = '')
+       {
                global $a;
 
                require_once 'include/datetime.php';
                require_once 'include/post_update.php';
                require_once 'mod/nodeinfo.php';
                require_once 'include/photos.php';
-               require_once 'include/user.php';
 
                // No parameter set? So return
                if ($command == '') {
                        return;
                }
 
-               logger("Starting cronjob ".$command, LOGGER_DEBUG);
+               logger("Starting cronjob " . $command, LOGGER_DEBUG);
 
                // Call possible post update functions
                // see include/post_update.php for more details
@@ -78,7 +80,7 @@ class CronJobs {
                        return;
                }
 
-               logger("Xronjob ".$command." is unknown.", LOGGER_DEBUG);
+               logger("Xronjob " . $command . " is unknown.", LOGGER_DEBUG);
 
                return;
        }
@@ -86,7 +88,8 @@ class CronJobs {
        /**
         * @brief Update the cached values for the number of photo albums per user
         */
-       private static function updatePhotoAlbums() {
+       private static function updatePhotoAlbums()
+       {
                $r = q("SELECT `uid` FROM `user` WHERE NOT `account_expired` AND NOT `account_removed`");
                if (!DBM::is_result($r)) {
                        return;
@@ -100,7 +103,8 @@ class CronJobs {
        /**
         * @brief Expire and remove user entries
         */
-       private static function expireAndRemoveUsers() {
+       private static function expireAndRemoveUsers()
+       {
                // expire any expired accounts
                q("UPDATE user SET `account_expired` = 1 where `account_expired` = 0
                        AND `account_expires_on` > '%s'
@@ -120,9 +124,9 @@ class CronJobs {
         *
         * @param App $a
         */
-       private static function clearCache(App $a) {
-
-               $last = Config::get('system','cache_last_cleared');
+       private static function clearCache(App $a)
+       {
+               $last = Config::get('system', 'cache_last_cleared');
 
                if ($last) {
                        $next = $last + (3600); // Once per hour
@@ -142,16 +146,16 @@ class CronJobs {
                clear_cache();
 
                // clear cache for photos
-               clear_cache($a->get_basepath(), $a->get_basepath()."/photo");
+               clear_cache($a->get_basepath(), $a->get_basepath() . "/photo");
 
                // clear smarty cache
-               clear_cache($a->get_basepath()."/view/smarty3/compiled", $a->get_basepath()."/view/smarty3/compiled");
+               clear_cache($a->get_basepath() . "/view/smarty3/compiled", $a->get_basepath() . "/view/smarty3/compiled");
 
                // clear cache for image proxy
                if (!Config::get("system", "proxy_disabled")) {
-                       clear_cache($a->get_basepath(), $a->get_basepath()."/proxy");
+                       clear_cache($a->get_basepath(), $a->get_basepath() . "/proxy");
 
-                       $cachetime = Config::get('system','proxy_cache_time');
+                       $cachetime = Config::get('system', 'proxy_cache_time');
                        if (!$cachetime) {
                                $cachetime = PROXY_DEFAULT_TIME;
                        }
@@ -166,13 +170,13 @@ class CronJobs {
                dba::delete('parsed_url', array("`created` < NOW() - INTERVAL 3 MONTH"));
 
                // Maximum table size in megabyte
-               $max_tablesize = intval(Config::get('system','optimize_max_tablesize')) * 1000000;
+               $max_tablesize = intval(Config::get('system', 'optimize_max_tablesize')) * 1000000;
                if ($max_tablesize == 0) {
                        $max_tablesize = 100 * 1000000; // Default are 100 MB
                }
                if ($max_tablesize > 0) {
                        // Minimum fragmentation level in percent
-                       $fragmentation_level = intval(Config::get('system','optimize_fragmentation')) / 100;
+                       $fragmentation_level = intval(Config::get('system', 'optimize_fragmentation')) / 100;
                        if ($fragmentation_level == 0) {
                                $fragmentation_level = 0.3; // Default value is 30%
                        }
@@ -194,7 +198,7 @@ class CronJobs {
                                // Calculate fragmentation
                                $fragmentation = $table["Data_free"] / ($table["Data_length"] + $table["Index_length"]);
 
-                               logger("Table ".$table["Name"]." - Fragmentation level: ".round($fragmentation * 100, 2), LOGGER_DEBUG);
+                               logger("Table " . $table["Name"] . " - Fragmentation level: " . round($fragmentation * 100, 2), LOGGER_DEBUG);
 
                                // Don't optimize tables that needn't to be optimized
                                if ($fragmentation < $fragmentation_level) {
@@ -202,12 +206,12 @@ class CronJobs {
                                }
 
                                // So optimize it
-                               logger("Optimize Table ".$table["Name"], LOGGER_DEBUG);
+                               logger("Optimize Table " . $table["Name"], LOGGER_DEBUG);
                                q("OPTIMIZE TABLE `%s`", dbesc($table["Name"]));
                        }
                }
 
-               Config::set('system','cache_last_cleared', time());
+               Config::set('system', 'cache_last_cleared', time());
        }
 
        /**
@@ -215,8 +219,8 @@ class CronJobs {
         *
         * @param App $a
         */
-       private static function repairDiaspora(App $a) {
-
+       private static function repairDiaspora(App $a)
+       {
                $starttime = time();
 
                $r = q("SELECT `id`, `url` FROM `contact`
@@ -241,7 +245,7 @@ class CronJobs {
                                continue;
                        }
 
-                       logger("Repair contact ".$contact["id"]." ".$contact["url"], LOGGER_DEBUG);
+                       logger("Repair contact " . $contact["id"] . " " . $contact["url"], LOGGER_DEBUG);
                        q("UPDATE `contact` SET `batch` = '%s', `notify` = '%s', `poll` = '%s', pubkey = '%s' WHERE `id` = %d",
                                dbesc($data["batch"]), dbesc($data["notify"]), dbesc($data["poll"]), dbesc($data["pubkey"]),
                                intval($contact["id"]));
@@ -252,15 +256,15 @@ class CronJobs {
         * @brief Do some repairs in database entries
         *
         */
-       private static function repairDatabase() {
-
+       private static function repairDatabase()
+       {
                // Sometimes there seem to be issues where the "self" contact vanishes.
                // We haven't found the origin of the problem by now.
                $r = q("SELECT `uid` FROM `user` WHERE NOT EXISTS (SELECT `uid` FROM `contact` WHERE `contact`.`uid` = `user`.`uid` AND `contact`.`self`)");
                if (DBM::is_result($r)) {
                        foreach ($r AS $user) {
-                               logger('Create missing self contact for user '.$user['uid']);
                                user_create_self_contact($user['uid']);
+                               logger('Create missing self contact for user ' . $user['uid']);
                        }
                }