同步代码

.github/scripts/deploy.sh

@@ -0,0 +1,58 @@
+#!/bin/sh -e
+
+# Deploys the official site to the production server.
+# See ../workflows/deploy.yml
+
+REPO="/opt/website"
+RELEASE_DIR="/home/public_html/site/releases"
+SHARED_DIR="/home/public_html/site/shared"
+USERGUIDE_DIR="/home/public_html/userguides"
+CONFIG_FILE="/home/public_html/config/.env.site"
+
+if [ "$(id -u)" = "0" ]; then
+    echo "Cannot be run as root. Please run as the user for deployment."
+    exit 1
+fi
+
+RELEASE=`date +"%Y-%m-%d-%H-%M-%S"`
+
+echo 'Update website repository\n'
+cd $REPO
+git switch master
+git pull
+
+echo 'Copy current release\n'
+cd $RELEASE_DIR
+sudo cp -pr $REPO ./$RELEASE
+
+echo 'Install composer dependencies\n'
+cd $RELEASE_DIR/$RELEASE
+composer install --no-dev
+
+if [ ! -d "$SHARED_DIR" ]; then
+    echo 'Create shared directory\n'
+    sudo mkdir -p "$SHARED_DIR"
+    echo 'Setup folder permissions\n'
+    sudo chown -R www-data:www-data writable
+    sudo chmod -R 755 writable
+    sudo cp -rp writable "$SHARED_DIR"
+fi
+
+echo 'Link writable\n'
+sudo rm -rf writable
+sudo ln -nsf "$SHARED_DIR/writable" writable
+
+echo 'Link .env\n'
+sudo ln -nsf $CONFIG_FILE .env
+
+echo 'Link user guides\n'
+ln -nsf $USERGUIDE_DIR/userguide4 public/user_guide
+ln -nsf $USERGUIDE_DIR/userguide3 public/userguide3
+ln -nsf $USERGUIDE_DIR/userguide2 public/userguide2
+
+echo 'Deploy: update symlink\n'
+cd $RELEASE_DIR
+sudo ln -nsf $RELEASE_DIR/$RELEASE "../current"
+
+echo 'Reload PHP8.1-FPM\n'
+sudo service php8.1-fpm reload

.github/workflows/deploy.yml

@@ -9,63 +9,15 @@ jobs:
     name: "Deploy to Production"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           ref: master
 
-      - name: Install SSH key
-        uses: shimataro/ssh-key-action@v2
+      - name: executing remote ssh commands using ssh key
+        uses: appleboy/ssh-action@v1.2.4
         with:
-          key: ${{ secrets.DEPLOY_KEY }}
-          name: id_rsa
-          known_hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
-
-      - name: Deploy to Webserver
-        uses: yeshan333/rsync-deploy-action@main
-        id: rsync-deploy-action
-        with:
-          ssh_login_username: ${{ secrets.DEPLOY_USER }}
-          remote_server_ip: ${{ secrets.DEPLOY_SSH_BOX }}
-          ssh_port: ${{ secrets.DEPLOY_PORT }}
-          ssh_private_key: ${{ secrets.DEPLOY_KEY }}
-          source_path: "./*"
-          destination_path: "/home/public_html/site/latest"
-
-      - name: Finalize deployment
-        uses: appleboy/ssh-action@master
-        env:
-          RELEASE_DIR: "/home/public_html/site/releases/"
-          RSYNC_DIR: "/home/public_html/site/latest/"
-          USERGUIDE_DIR: "/home/public_html/userguides"
-          CONFIG_FILE: "/home/public_html/config/.env.site"
-        with:
-          host: ${{ secrets.DEPLOY_SSH_BOX }}
-          username: ${{ secrets.DEPLOY_USER }}
-          key: ${{ secrets.DEPLOY_KEY }}
-          script_stop: true
-          envs: RELEASE_DIR,CONFIG_FILE,RSYNC_DIR,USERGUIDE_DIR
-          script: |
-            cd ~/
-            RELEASE=`date +"%d-%m-%Y-%H-%M-%S"`
-
-            echo $'Copy current release\n'
-            cd $RELEASE_DIR
-            cp -r ../latest ./$RELEASE
-
-            echo $'Install composer dependencies\n'
-            cd $RELEASE_DIR/$RELEASE
-            composer install
-
-            echo $'Setup FS\n'
-            cd $RELEASE_DIR/$RELEASE
-            sudo chmod -R 777 writable
-            sudo chmod -R a+rx vendor
-            sudo ln -nsf $CONFIG_FILE .env
-
-            echo $'Link current user guide\n'
-            sudo ln -nsf $USERGUIDE_DIR/userguide4 public/user_guide
-
-            echo $'Set up Links\n'
-            cd $RELEASE_DIR
-            sudo ln -nsf $RELEASE_DIR/$RELEASE "../current"
-            sudo service php8.1-fpm reload
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          key: ${{ secrets.KEY }}
+          port: ${{ secrets.PORT }}
+          script: /opt/website/.github/scripts/deploy.sh

.github/workflows/infection.yml

@@ -26,12 +26,12 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           tools: infection, phpunit
           extensions: intl, json, mbstring, gd, xml, sqlite3
           coverage: xdebug
@@ -48,7 +48,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
@@ -65,6 +65,6 @@ jobs:
       - name: Run Infection for added files only
         run: |
           git fetch --depth=1 origin $GITHUB_BASE_REF
-          infection --threads=max --git-diff-lines --git-diff-base=origin/$GITHUB_BASE_REF --ignore-msi-with-no-mutations --only-covered --logger-github
+          infection --threads=max --git-diff-lines --git-diff-base=origin/$GITHUB_BASE_REF --ignore-msi-with-no-mutations --logger-github
         env:
           GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/phpcsfixer.yml

@@ -34,7 +34,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
@@ -49,7 +49,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}

.github/workflows/phpstan.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -54,7 +54,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
@@ -64,7 +64,7 @@ jobs:
         run: mkdir -p build/phpstan
 
       - name: Cache PHPStan results
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: build/phpstan
           key: ${{ runner.os }}-phpstan-${{ github.sha }}

.github/workflows/phpunit.yml

@@ -29,7 +29,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
@@ -45,7 +45,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
@@ -60,7 +60,7 @@ jobs:
           fi
 
       - name: Test with PHPUnit
-        run: vendor/bin/phpunit --verbose --coverage-text
+        run: vendor/bin/phpunit --coverage-text
         env:
           TERM: xterm-256color
           TACHYCARDIA_MONITOR_GA: enabled

.github/workflows/rector.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
@@ -54,7 +54,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}

README.md

@@ -41,7 +41,7 @@ Some of the programming design decisions reflected:
 
 ## Server Requirements
 
-PHP version 7.4 or higher is required, with the following extensions installed:
+PHP version 8.1 or higher is required, with the following extensions installed:
 
 - [intl](https://php.net/manual/en/intl.requirements.php)
 - [libcurl](https://php.net/manual/en/curl.requirements.php) if you plan to use the `HTTP\CURLRequest` library

app/Config/App.php

@@ -14,18 +14,18 @@ class App extends BaseConfig
      * URL to your CodeIgniter root. Typically, this will be your base URL,
      * WITH a trailing slash:
      *
-     *    http://example.com/
+     * E.g., http://example.com/
      */
     public string $baseURL = 'http://localhost:8080/';
 
     /**
      * Allowed Hostnames in the Site URL other than the hostname in the baseURL.
      * If you want to accept multiple Hostnames, set this.
      *
-     * E.g. When your site URL ($baseURL) is 'http://example.com/', and your site
-     *      also accepts 'http://media.example.com/' and
-     *      'http://accounts.example.com/':
-     *          ['media.example.com', 'accounts.example.com']
+     * E.g.,
+     * When your site URL ($baseURL) is 'http://example.com/', and your site
+     * also accepts 'http://media.example.com/' and 'http://accounts.example.com/':
+     *     ['media.example.com', 'accounts.example.com']
      *
      * @var list<string>
      */
@@ -36,9 +36,9 @@ class App extends BaseConfig
      * Index File
      * --------------------------------------------------------------------------
      *
-     * Typically this will be your index.php file, unless you've renamed it to
-     * something else. If you are using mod_rewrite to remove the page set this
-     * variable so that it is blank.
+     * Typically, this will be your `index.php` file, unless you've renamed it to
+     * something else. If you have configured your web server to remove this file
+     * from your site URIs, set this variable to an empty string.
      */
     public string $indexPage = '';
 
@@ -48,17 +48,41 @@ class App extends BaseConfig
      * --------------------------------------------------------------------------
      *
      * This item determines which server global should be used to retrieve the
-     * URI string.  The default setting of 'REQUEST_URI' works for most servers.
+     * URI string. The default setting of 'REQUEST_URI' works for most servers.
      * If your links do not seem to work, try one of the other delicious flavors:
      *
-     * 'REQUEST_URI'    Uses $_SERVER['REQUEST_URI']
-     * 'QUERY_STRING'   Uses $_SERVER['QUERY_STRING']
-     * 'PATH_INFO'      Uses $_SERVER['PATH_INFO']
+     *  'REQUEST_URI': Uses $_SERVER['REQUEST_URI']
+     * 'QUERY_STRING': Uses $_SERVER['QUERY_STRING']
+     *    'PATH_INFO': Uses $_SERVER['PATH_INFO']
      *
      * WARNING: If you set this to 'PATH_INFO', URIs will always be URL-decoded!
      */
     public string $uriProtocol = 'REQUEST_URI';
 
+    /*
+    |--------------------------------------------------------------------------
+    | Allowed URL Characters
+    |--------------------------------------------------------------------------
+    |
+    | This lets you specify which characters are permitted within your URLs.
+    | When someone tries to submit a URL with disallowed characters they will
+    | get a warning message.
+    |
+    | As a security measure you are STRONGLY encouraged to restrict URLs to
+    | as few characters as possible.
+    |
+    | By default, only these are allowed: `a-z 0-9~%.:_-`
+    |
+    | Set an empty string to allow all characters -- but only if you are insane.
+    |
+    | The configured value is actually a regular expression character group
+    | and it will be used as: '/\A[<permittedURIChars>]+\z/iu'
+    |
+    | DO NOT CHANGE THIS UNLESS YOU FULLY UNDERSTAND THE REPERCUSSIONS!!
+    |
+    */
+    public string $permittedURIChars = 'a-z 0-9~%.:_\-';
+
     /**
      * --------------------------------------------------------------------------
      * Default Locale
@@ -94,7 +118,7 @@ class App extends BaseConfig
      *
      * IncomingRequest::setLocale() also uses this list.
      *
-     * @var string[]
+     * @var list<string>
      */
     public array $supportedLocales = ['en'];
 
@@ -106,7 +130,8 @@ class App extends BaseConfig
      * The default timezone that will be used in your application to display
      * dates with the date helper, and can be retrieved through app_timezone()
      *
-     * @see https://www.php.net/manual/en/timezones.php for list of timezones supported by PHP.
+     * @see https://www.php.net/manual/en/timezones.php for list of timezones
+     *      supported by PHP.
      */
     public string $appTimezone = 'UTC';
 
@@ -130,7 +155,7 @@ class App extends BaseConfig
      * If true, this will force every request made to this application to be
      * made via a secure connection (HTTPS). If the incoming request is not
      * secure, the user will be redirected to a secure version of the page
-     * and the HTTP Strict Transport Security header will be set.
+     * and the HTTP Strict Transport Security (HSTS) header will be set.
      */
     public bool $forceGlobalSecureRequests = true;