Merge remote-tracking branch 'upstream/develop' into json-ld

[friendica.git] / src / Model / Register.php

diff --git a/src/Model/Register.php b/src/Model/Register.php
index e54db87a6b7fee15643a02e62fe4f4fe052566d0..c24e66d4d07dd67a33cfb7f1523289dd1cfadce5 100644 (file)
--- a/src/Model/Register.php
+++ b/src/Model/Register.php
@@ -1,60 +1,81 @@
 <?php
-
 /**
- * @file src/Model/Register.php
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica\Model;
 
+use Friendica\Content\Pager;
 use Friendica\Database\DBA;
 use Friendica\Util\DateTimeFormat;
+use Friendica\Util\Strings;
 
 /**
  * Class interacting with the register database table
- *
- * @author Hypolite Petovan <mrpetovan@gmail.com>
  */
 class Register
 {
        /**
         * Return the list of pending registrations
         *
-        * @return array
+        * @param int $start Start count (Default is 0)
+        * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
+        * @return array|bool Array on succes, false on failure
+        * @throws \Exception
+        */
+       public static function getPending(int $start = 0, int $count = Pager::ITEMS_PER_PAGE)
+       {
+               return DBA::selectToArray('pending-view', [], [], ['limit' => [$start, $count]]);
+       }
+
+       /**
+        * Returns the pending user based on a given user id
+        *
+        * @param int $uid The user id
+        *
+        * @return array|bool Array on succes, false on failure
+        * @throws \Exception
         */
-       public static function getPending()
+       public static function getPendingForUser(int $uid)
        {
-               $stmt = DBA::p(
-                       "SELECT `register`.*, `contact`.`name`, `user`.`email`
-                       FROM `register`
-                       INNER JOIN `contact` ON `register`.`uid` = `contact`.`uid`
-                       INNER JOIN `user` ON `register`.`uid` = `user`.`uid`"
-               );
-
-               return DBA::toArray($stmt);
+               return DBA::selectFirst('pending-view', [], ['uid' => $uid, 'self' => true]);
        }
 
        /**
         * Returns the pending registration count
         *
         * @return int
+        * @throws \Exception
         */
-       public static function getPendingCount()
+       public static function getPendingCount(): int
        {
-               $register = DBA::fetchFirst(
-                       "SELECT COUNT(*) AS `count`
-                       FROM `register`
-                       INNER JOIN `contact` ON `register`.`uid` = `contact`.`uid` AND `contact`.`self`"
-               );
-
-               return $register['count'];
+               return DBA::count('pending-view', ['self' => true]);
        }
 
        /**
         * Returns the register record associated with the provided hash
         *
         * @param  string $hash
-        * @return array
+        * @return array|bool Array on succes, false on failure
+        * @throws \Exception
         */
-       public static function getByHash($hash)
+       public static function getByHash(string $hash)
        {
                return DBA::selectFirst('register', [], ['hash' => $hash]);
        }
@@ -62,10 +83,11 @@ class Register
        /**
         * Returns true if a register record exists with the provided hash
         *
-        * @param  string  $hash
+        * @param  string $hash
         * @return boolean
+        * @throws \Exception
         */
-       public static function existsByHash($hash)
+       public static function existsByHash(string $hash): bool
        {
                return DBA::exists('register', ['hash' => $hash]);
        }
@@ -74,10 +96,11 @@ class Register
         * Creates a register record for an invitation and returns the auto-generated code for it
         *
         * @return string
+        * @throws \Exception
         */
-       public static function createForInvitation()
+       public static function createForInvitation(): string
        {
-               $code = autoname(8) . srand(1000, 9999);
+               $code = Strings::getRandomName(8) . random_int(1000, 9999);
 
                $fields = [
                        'hash' => $code,
@@ -97,10 +120,11 @@ class Register
         * @param  string  $language The registration language
         * @param  string  $note     An additional message from the user
         * @return boolean
+        * @throws \Exception
         */
-       public static function createForApproval($uid, $language, $note = '')
+       public static function createForApproval(int $uid, string $language, string $note = ''): bool
        {
-               $hash = random_string();
+               $hash = Strings::getRandomHex();
 
                if (!User::exists($uid)) {
                        return false;
@@ -121,10 +145,11 @@ class Register
        /**
         * Deletes a register record by the provided hash and returns the success of the database deletion
         *
-        * @param  string  $hash
+        * @param  string $hash
         * @return boolean
+        * @throws \Exception
         */
-       public static function deleteByHash($hash)
+       public static function deleteByHash(string $hash): bool
        {
                return DBA::delete('register', ['hash' => $hash]);
        }