Merge pull request #6808 from ChurchCRM/remove-menu-php

Remove unused Menu.php since v2/dashboard is the new landing page
ChurchCRM · Feb 11, 2024 · 7073cc1 · 7073cc1
2 parents ffbd5fa + abdb40d
commit 7073cc1
Show file tree

Hide file tree

Showing 84 changed files with 180 additions and 326 deletions.
diff --git a/docker/cypress.config.ts b/docker/cypress.config.ts
@@ -14,6 +14,7 @@ export default defineConfig({
     'admin.api.key': 'ajGwpy8Pdai22XDUpqjC5Ob04v0eG7EGgb4vz2bD2juT8YDmfM',
     'user.api.key': 'JZJApQ9XOnF7nvupWZlTWBRrqMtHE9eNcWBTUzEWGqL4Sdqp6C',
   },
+  retries: 2,
   e2e: {
     // We've imported your old cypress plugins here.
     // You may want to clean this up later by importing these.

diff --git a/src/BackupDatabase.php b/src/BackupDatabase.php
@@ -21,10 +21,7 @@
 
 // Security: User must be an Admin to access this page.
 // Otherwise, re-direct them to the main menu.
-if (!AuthenticationManager::getCurrentUser()->isAdmin()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isAdmin());
 
 
 // Set the page title and include HTML header

diff --git a/src/BatchWinnerEntry.php b/src/BatchWinnerEntry.php
@@ -118,7 +118,7 @@
             <input type="button" class="btn btn-default" value="<?= gettext('Cancel') ?>" name="Cancel" onclick="javascript:document.location='<?php if (strlen($linkBack) > 0) {
                 echo $linkBack;
                                                                 } else {
-                                                                    echo 'Menu.php';
+                                                                    echo 'v2/dashboard';
                                                                 } ?>';">
         </td>
     </tr>

diff --git a/src/CSVImport.php b/src/CSVImport.php
@@ -26,10 +26,7 @@
 use ChurchCRM\Utils\InputUtils;
 use ChurchCRM\Utils\RedirectUtils;
 
-if (!AuthenticationManager::getCurrentUser()->isAdmin()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isAdmin());
 
 /**
  * A monogamous society is assumed, however  it can be patriarchal or matriarchal

diff --git a/src/CanvassAutomation.php b/src/CanvassAutomation.php
@@ -23,10 +23,7 @@
 $sPageTitle = gettext('Canvass Automation');
 
 // Security: User must have canvasser permission to use this form
-if (!AuthenticationManager::getCurrentUser()->isCanvasserEnabled()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isCanvasserEnabled());
 
 $iFYID = CurrentFY();
 if (array_key_exists('idefaultFY', $_SESSION)) {

diff --git a/src/CanvassEditor.php b/src/CanvassEditor.php
@@ -19,10 +19,7 @@
 use ChurchCRM\Utils\RedirectUtils;
 
 // Security: User must have canvasser permission to use this form
-if (!AuthenticationManager::getCurrentUser()->isCanvasserEnabled()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isCanvasserEnabled());
 
 require 'Include/CanvassUtilities.php';
 
@@ -244,7 +241,7 @@
             <input type="button" class="btn btn-default" value="<?= gettext('Cancel') ?>" name="Cancel" onclick="javascript:document.location='<?php if (strlen($linkBack) > 0) {
                 echo $linkBack;
                                                                 } else {
-                                                                    echo 'Menu.php';
+                                                                    echo 'v2/dashboard';
                                                                 } ?>';">
 
     </div>

diff --git a/src/CartToEvent.php b/src/CartToEvent.php
@@ -25,10 +25,7 @@
 use ChurchCRM\Utils\RedirectUtils;
 
 // Security: User must have Manage Groups & Roles permission
-if (!AuthenticationManager::getCurrentUser()->isManageGroupsEnabled()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isManageGroupsEnabled());
 
 // Was the form submitted?
 if (isset($_POST['Submit']) && count($_SESSION['aPeopleCart']) > 0 && isset($_POST['EventID'])) {

diff --git a/src/CartToFamily.php b/src/CartToFamily.php
@@ -21,10 +21,7 @@
 use ChurchCRM\Utils\RedirectUtils;
 
 // Security: User must have add records permission
-if (!AuthenticationManager::getCurrentUser()->isAddRecordsEnabled()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isAddRecordsEnabled());
 
 // Was the form submitted?
 if (isset($_POST['Submit']) && count($_SESSION['aPeopleCart']) > 0) {

diff --git a/src/CartToGroup.php b/src/CartToGroup.php
@@ -22,10 +22,7 @@
 use ChurchCRM\Utils\RedirectUtils;
 
 // Security: User must have Manage Groups & Roles permission
-if (!AuthenticationManager::getCurrentUser()->isManageGroupsEnabled()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isManageGroupsEnabled());
 
 // Was the form submitted?
 if ((isset($_GET['groupeCreationID']) || isset($_POST['Submit'])) && count($_SESSION['aPeopleCart']) > 0) {

diff --git a/src/ChurchCRM/Authentication/AuthenticationManager.php b/src/ChurchCRM/Authentication/AuthenticationManager.php
@@ -127,7 +127,7 @@ public static function authenticate(AuthenticationRequest $AuthenticationRequest
         }
 
         if ($result->isAuthenticated && !$result->preventRedirect) {
-            $redirectLocation = array_key_exists('location', $_SESSION) ? $_SESSION['location'] : 'Menu.php';
+            $redirectLocation = $_SESSION['location'] ?? 'v2/dashboard';
             NotificationService::updateNotifications();
             $logger->debug(
                 'Authentication Successful; redirecting to: ' . $redirectLocation
@@ -209,4 +209,10 @@ public static function getForgotPasswordURL(): string
         // but rather redirect users to some other password reset mechanism.
         return SystemURLs::getRootPath() . '/session/forgot-password/reset-request';
     }
+    public static function redirectHomeIfFalse(bool $hasAccess): void
+    {
+        if (!$hasAccess) {
+            RedirectUtils::redirect('v2/dashboard');
+        }
+    }
 }
diff --git a/src/ChurchCRM/Backup/BackupJob.php b/src/ChurchCRM/Backup/BackupJob.php
@@ -60,7 +60,7 @@ public function __construct(string $BaseName, $BackupType, $IncludeExtraneousFil
         );
     }
 
-    public function copyToWebDAV(string $Endpoint, string $Username, string $Password)
+    public function copyToWebDAV(string $Endpoint, string $Username, string $Password): bool
     {
         LoggerUtils::getAppLogger()->info('Beginning to copy backup to: ' . $Endpoint);
 
@@ -78,7 +78,7 @@ public function copyToWebDAV(string $Endpoint, string $Username, string $Passwor
             curl_setopt($ch, CURLOPT_INFILESIZE, $this->BackupFile->getSize());
             LoggerUtils::getAppLogger()->debug('Beginning to send file');
             $time = new ExecutionTime();
-            $result = curl_exec($ch);
+            $result = (bool) curl_exec($ch);
             if (curl_error($ch)) {
                 $error_msg = curl_error($ch);
             }

diff --git a/src/ChurchCRM/Backup/JobBase.php b/src/ChurchCRM/Backup/JobBase.php
@@ -16,7 +16,7 @@ class JobBase
      */
     protected $TempFolder;
 
-    protected function createEmptyTempFolder()
+    protected function createEmptyTempFolder(): string
     {
         // both backup and restore operations require a clean temporary working folder.  Create it.
         $TempFolder = SystemURLs::getDocumentRoot() . '/tmp_attach/ChurchCRMBackups';

diff --git a/src/ChurchCRM/Config/Menu/Menu.php b/src/ChurchCRM/Config/Menu/Menu.php
@@ -32,7 +32,7 @@ public static function getMenu(): ?array
     private static function buildMenuItems(): array
     {
         return [
-            'Dashboard'    => new MenuItem(gettext('Dashboard'), 'Menu.php', true, 'fa-tachometer-alt'),
+            'Dashboard'    => new MenuItem(gettext('Dashboard'), 'v2/dashboard', true, 'fa-tachometer-alt'),
             'Calendar'     => self::getCalendarMenu(),
             'People'       => self::getPeopleMenu(),
             'Groups'       => self::getGroupMenu(),

diff --git a/src/ChurchCRM/Emails/users/BaseUserEmail.php b/src/ChurchCRM/Emails/users/BaseUserEmail.php
@@ -26,7 +26,7 @@ public function __construct($user)
 
     abstract protected function getSubSubject();
 
-    public function getTokens()
+    public function getTokens(): array
     {
         $myTokens = ['toName' => $this->user->getPerson()->getFirstName(),
             'userName'        => $this->user->getUserName(),
@@ -37,7 +37,7 @@ public function getTokens()
         return array_merge($this->getCommonTokens(), $myTokens);
     }
 
-    protected function getFullURL()
+    protected function getFullURL(): string
     {
         return SystemURLs::getURL() . '/session/begin?username=' . $this->user->getUserName();
     }

diff --git a/src/ChurchCRM/Service/MailChimpService.php b/src/ChurchCRM/Service/MailChimpService.php
@@ -75,14 +75,14 @@ private function getListsFromCache()
         return $_SESSION['MailChimpLists'];
     }
 
-    public function isEmailInMailChimp(?string $email)
+    public function isEmailInMailChimp(?string $email): array
     {
         if (empty($email)) {
-            return new Exception(gettext('No email passed in'));
+            throw new Exception(gettext('No email passed in'));
         }
 
         if (!$this->isActive()) {
-            return new Exception(gettext('Mailchimp is not active'));
+            throw new Exception(gettext('Mailchimp is not active'));
         }
 
         $lists = $this->getListsFromCache();

diff --git a/src/ChurchCRM/dto/Cart.php b/src/ChurchCRM/dto/Cart.php
@@ -112,7 +112,7 @@ public static function countPeople(): int
         return count($_SESSION['aPeopleCart']);
     }
 
-    public static function convertCartToString($aCartArray)
+    public static function convertCartToString($aCartArray): string
     {
         // Implode the array
         $sCartString = implode(',', $aCartArray);

diff --git a/src/ChurchCRM/dto/Photo.php b/src/ChurchCRM/dto/Photo.php
@@ -143,11 +143,13 @@ private function photoHunt(): void
                 }
 
                 if (SystemConfig::getBooleanValue('bEnableGravatarPhotos')) {
-                    $photoPath = $this->loadFromGravatar($personEmail, $baseName);
-                    if ($photoPath) {
+                    try {
+                        $photoPath = $this->loadFromGravatar($personEmail, $baseName);
                         $this->setURIs($photoPath);
 
                         return;
+                    } catch (\Exception $e) {
+                        // do nothing
                     }
                 }
             }
@@ -166,7 +168,7 @@ private function convertToPNG(): void
         $this->setURIs($targetPath);
     }
 
-    private function getGDImage($sourceImagePath)
+    private function getGDImage($sourceImagePath): \GdImage
     {
         $sourceImageType = exif_imagetype($sourceImagePath);
         switch ($sourceImageType) {
@@ -182,6 +184,7 @@ private function getGDImage($sourceImagePath)
             default:
                 throw new \Exception('Unsupported image type: ' . $sourceImageType);
         }
+        MiscUtils::throwIfFailed($sourceGDImage);
 
         return $sourceGDImage;
     }
@@ -193,18 +196,24 @@ private function ensureThumbnailsPath(): void
         }
     }
 
-    public function getThumbnailBytes()
+    public function getThumbnailBytes(): string
     {
         if (!file_exists($this->photoThumbURI)) {
             $this->createThumbnail();
         }
 
-        return file_get_contents($this->photoThumbURI);
+        $content = file_get_contents($this->photoThumbURI);
+        MiscUtils::throwIfFailed($content);
+
+        return $content;
     }
 
-    public function getPhotoBytes()
+    public function getPhotoBytes(): string|false
     {
-        return file_get_contents($this->photoURI);
+        $content = file_get_contents($this->photoURI);
+        MiscUtils::throwIfFailed($content);
+
+        return $content;
     }
 
     public function getPhotoContentType()
@@ -237,7 +246,7 @@ public function getPhotoURI()
         return $this->photoURI;
     }
 
-    private function loadFromGravatar($email, string $baseName)
+    private function loadFromGravatar($email, string $baseName): string
     {
         $s = 60;
         $d = '404';
@@ -256,10 +265,10 @@ private function loadFromGravatar($email, string $baseName)
             return $photoPath;
         }
 
-        return false;
+        throw new \Exception('Gravatar not found');
     }
 
-    private function loadFromGoogle($email, string $baseName)
+    private function loadFromGoogle($email, string $baseName): string|false
     {
         $url = 'http://picasaweb.google.com/data/entry/api/user/';
         $url .= strtolower(trim($email));
@@ -284,7 +293,7 @@ private function loadFromGoogle($email, string $baseName)
         return false;
     }
 
-    private function getRandomColor($image)
+    private function getRandomColor(\GdImage $image): int|false
     {
         $red = random_int(0, 150);
         $green = random_int(0, 150);
@@ -318,6 +327,7 @@ private function renderInitials(): void
         $pointSize = SystemConfig::getValue('iInitialsPointSize');
         $font = SystemURLs::getDocumentRoot() . '/fonts/Roboto-Regular.ttf';
         $image = imagecreatetruecolor($width, $height);
+        MiscUtils::throwIfFailed($image);
         $bgcolor = $this->getRandomColor($image);
         $white = imagecolorallocate($image, 255, 255, 255);
         imagefilledrectangle($image, 0, 0, $height, $width, $bgcolor);

diff --git a/src/ChurchCRM/utils/InputUtils.php b/src/ChurchCRM/utils/InputUtils.php
@@ -17,13 +17,24 @@ public static function legacyFilterInputArr(array $arr, $key, $type = 'string',
         }
     }
 
-    public static function translateSpecialCharset($string)
+    public static function translateSpecialCharset($string): string
     {
         if (empty($string)) {
             return '';
         }
 
-        return (SystemConfig::getValue('sCSVExportCharset') === 'UTF-8') ? gettext($string) : iconv('UTF-8', SystemConfig::getValue('sCSVExportCharset'), gettext($string));
+        if (SystemConfig::getValue('sCSVExportCharset') === 'UTF-8') {
+            return gettext($string);
+        }
+
+        $resultString = iconv(
+            'UTF-8',
+            SystemConfig::getValue('sCSVExportCharset'),
+            gettext($string)
+        );
+        MiscUtils::throwIfFailed($resultString);
+
+        return $resultString;
     }
 
     public static function filterString($sInput): string

diff --git a/src/ChurchCRM/utils/RedirectUtils.php b/src/ChurchCRM/utils/RedirectUtils.php
@@ -36,6 +36,6 @@ public static function absoluteRedirect(string $sTargetURL): void
     public static function securityRedirect(string $missingRole): void
     {
         LoggerUtils::getAppLogger()->info('Security Redirect Request due to Role: ' . $missingRole);
-        self::Redirect('Menu.php');
+        self::Redirect('v2/dashboard');
     }
 }
diff --git a/src/ConvertIndividualToFamily.php b/src/ConvertIndividualToFamily.php
@@ -29,10 +29,7 @@
 use ChurchCRM\Utils\RedirectUtils;
 
 // Security
-if (!AuthenticationManager::getCurrentUser()->isAdmin()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isAdmin());
 
 if ($_GET['all'] == 'true') {
     $bDoAll = true;

diff --git a/src/DepositSlipEditor.php b/src/DepositSlipEditor.php
@@ -41,14 +41,14 @@
 
     // Security: User must have finance permission or be the one who created this deposit
     if (!(AuthenticationManager::getCurrentUser()->isFinanceEnabled() || AuthenticationManager::getCurrentUser()->getId() == $thisDeposit->getEnteredby())) {
-        RedirectUtils::redirect('Menu.php');
+        RedirectUtils::redirect('v2/dashboard');
         exit;
     }
 } elseif ($iDepositSlipID == 0) {
     RedirectUtils::redirect('FindDepositSlip.php');
     exit;
 } else {
-    RedirectUtils::redirect('Menu.php');
+    RedirectUtils::redirect('v2/dashboard');
 }
 
 //Set the page title

diff --git a/src/DirectoryReports.php b/src/DirectoryReports.php
@@ -21,10 +21,7 @@
 use ChurchCRM\Utils\RedirectUtils;
 
 // Check for Create Directory user permission.
-if (!AuthenticationManager::getCurrentUser()->isCreateDirectoryEnabled()) {
-    RedirectUtils::redirect('Menu.php');
-    exit;
-}
+AuthenticationManager::redirectHomeIfFalse(AuthenticationManager::getCurrentUser()->isCreateDirectoryEnabled());
 
 // Set the page title and include HTML header
 $sPageTitle = gettext('Directory reports');
@@ -285,7 +282,7 @@
 <p align="center">
 <BR>
 <input type="submit" class="btn btn-primary" name="Submit" value="<?= gettext('Create Directory') ?>">
-<input type="button" class="btn btn-default" name="Cancel" <?= 'value="' . gettext('Cancel') . '"' ?> onclick="javascript:document.location='Menu.php';">
+<input type="button" class="btn btn-default" name="Cancel" <?= 'value="' . gettext('Cancel') . '"' ?> onclick="javascript:document.location='v2/dashboard';">
 </p>
 </form>
 </div>