merge backend refactor into main branch

.github/workflows/download.yaml

@@ -2,59 +2,20 @@ name: dl_constants.php maintainer
 on:
   release:
     types: [published]
-    branches: ["app", "moodle"]
+    branches: ["main"]
 jobs:
-  update-frontend-files:
-    name: Update app version & download url
-    if: github.event.release.target_commitish == 'app' && !github.event.release.prerelease
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-        with:
-          ref: web
-
-      - name: Update linux url
-        run: sed -i '/linux/c\const dl_linux = "${{ github.server_url }}/${{ github.repository }}/releases/download/${{ github.event.release.tag_name }}/LB.Planner-x86_64.AppImage";' /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/snippets/dl_constants.php
-
-      - name: Update linux comment
-        run: sed -i '/Linux download url/c\ * Linux download url [@${{ github.event.release.tag_name }}](${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.event.release.tag_name }}).' /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/snippets/dl_constants.php
-
-      - name: Update windows url
-        run: sed -i '/windows/c\const dl_windows = "${{ github.server_url }}/${{ github.repository }}/releases/download/${{ github.event.release.tag_name }}/LB.Planner.Setup.exe";' /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/snippets/dl_constants.php
-
-      - name: Update windows comment
-        run: sed -i '/Windows download url/c\ * Windows download url [@${{ github.event.release.tag_name }}](${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.event.release.tag_name }}).' /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/snippets/dl_constants.php
-
-      - name: Update mac url
-        run: sed -i '/mac/c\const dl_mac = "${{ github.server_url }}/${{ github.repository }}/releases/download/${{ github.event.release.tag_name }}/LB.Planner.Setup.dmg";' /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/snippets/dl_constants.php
-
-      - name: Update mac comment
-        run: sed -i '/MacOS download url/c\ * MacOS download url [@${{ github.event.release.tag_name }}](${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.event.release.tag_name }}).' /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/snippets/dl_constants.php
-
-      - name: Commit & Push
-        uses: Andro999b/push@v1.3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: web
-          message: "Github Actions - Updated dl_constants.php to ${{ github.event.release.tag_name }}"
-      - name: SFTP Upload to Webserver
-        uses: Dylan700/sftp-upload-action@v1.1.4
-        with:
-          server: ${{ secrets.SFTP_HOST }}
-          username: ${{ secrets.SFTP_USER }}
-          password: ${{ secrets.SFTP_PASSWORD }}
-          uploads: |
-            snippets/dl_constants.php => /htdocs/snippets/dl_constants.php
   update-backend-files:
     name: Update plugin version & download url
-    if: github.event.release.target_commitish == 'moodle' && !github.event.release.prerelease
+    if: '!github.event.release.prerelease'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
         with:
-          ref: web
+          repository: 'necodeIT/lb_planner_web'
+          ref: main
+          persist-credentials: false
+          fetch-depth: 0
 
       - name: Update plugin url
         run: sed -i '/dl_plugin/c\const dl_plugin = "${{ github.server_url }}/${{ github.repository }}/releases/download/${{ github.event.release.tag_name }}/lb_planner.zip";' /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/snippets/dl_constants.php
@@ -65,8 +26,9 @@ jobs:
       - name: Commit & Push
         uses: Andro999b/push@v1.3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: web
+          github_token: ${{ secrets.REPO_WEB_TOKEN }}
+          repository: 'necodeIT/lb_planner_web'
+          branch: main
           message: "Github Actions - Updated dl_constants.php to ${{ github.event.release.tag_name }}"
       - name: SFTP Upload to Webserver
         uses: Dylan700/sftp-upload-action@v1.1.4

.github/workflows/gen_docs.yaml

@@ -0,0 +1,46 @@
+name: Generate API Docs
+
+on:
+  push:
+    branches:
+      - LP-55-Backend-Refactor # This is temporary and will be replaced by `main` once the refactor is complete
+  workflow_dispatch: # For manual triggering
+
+jobs:
+  generate-api-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          ref: LP-55-Backend-Refactor # This is temporary and will be replaced by `main` once the refactor is complete
+          path: moodle
+
+      - name: Checkout docs repo
+        uses: actions/checkout@v3
+        with:
+          repository: 'necodeIT/lb_planner_docs'
+          ref: main
+          clean: false
+          path: docs
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v4.7.1
+        with:
+          python-version: '3.12'
+
+      - name: Generate docs
+        working-directory: moodle
+        run: python document_services.py ../docs/moodle
+
+      - name: Push new documentation to docs repo
+        working-directory: docs
+        uses: Andro999b/push@v1.3
+        with:
+          github_token: ${{ secrets.REPO_DOCS_TOKEN }}
+          repository: 'necodeIT/lb_planner_docs'
+          branch: main
+          message: "GitHub Actions - Update Web Service Documentation to ${{ github.sha }}"

.github/workflows/gha.dist.yml

@@ -0,0 +1,122 @@
+name: CI
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    branches:
+      - LP-55-Backend-Refactor # Temporary. Will be changed to `main` when refactor is complete
+
+jobs:
+  Analysis:
+    runs-on: ubuntu-22.04
+
+    services:
+      postgres:
+        image: postgres:13
+        env:
+          POSTGRES_USER: 'postgres'
+          POSTGRES_HOST_AUTH_METHOD: 'trust'
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3
+
+      mariadb:
+        image: mariadb:10
+        env:
+          MYSQL_USER: 'root'
+          MYSQL_ALLOW_EMPTY_PASSWORD: "true"
+          MYSQL_CHARACTER_SET_SERVER: "utf8mb4"
+          MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci"
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['7.4']
+        moodle-branch: ['MOODLE_401_STABLE']
+        database: [mariadb]
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+        with:
+          path: plugin
+
+      - name: Setup PHP ${{ matrix.php }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: ${{ matrix.extensions }}
+          ini-values: max_input_vars=5000
+          # If you are not using code coverage, keep "none". Otherwise, use "pcov" (Moodle 3.10 and up) or "xdebug".
+          # If you try to use code coverage with "none", it will fallback to phpdbg (which has known problems).
+          coverage: none
+
+      - name: Initialise moodle-plugin-ci
+        run: |
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
+          echo $(cd ci/bin; pwd) >> $GITHUB_PATH
+          echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
+          sudo locale-gen en_AU.UTF-8
+          echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
+
+      - name: Install NVM and Node # TODO: remove this step after https://github.com/moodlehq/moodle-plugin-ci/issues/309 is fixed
+        run: |
+          curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
+          export NVM_DIR="$HOME/.nvm"
+          [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+          nvm install 20
+          nvm use 20
+
+      - name: Install moodle-plugin-ci
+        run: |
+          moodle-plugin-ci install --plugin ./plugin/lbplanner --db-host=127.0.0.1
+        env:
+          DB: ${{ matrix.database }}
+          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
+
+      - name: PHP Lint
+        if: ${{ always() }}
+        run: moodle-plugin-ci phplint
+
+      - name: PHP Copy/Paste Detector
+        continue-on-error: true # This step will show errors but will not fail
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpcpd
+
+      - name: PHP Mess Detector
+        continue-on-error: true # This step will show errors but will not fail
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpmd
+
+      - name: Moodle Code Checker
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpcs --max-warnings 1
+
+      - name: Moodle PHPDoc Checker
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpdoc --max-warnings 0
+
+      - name: Validating
+        if: ${{ always() }}
+        run: moodle-plugin-ci validate
+
+      - name: Check upgrade savepoints
+        if: ${{ always() }}
+        run: moodle-plugin-ci savepoints
+
+      - name: Mustache Lint
+        if: ${{ always() }}
+        run: moodle-plugin-ci mustache
+
+      - name: Grunt
+        if: ${{ always() }}
+        run: moodle-plugin-ci grunt --max-lint-warnings 0
+
+      - name: PHPUnit tests
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpunit --fail-on-warning

.github/workflows/test_docs.yaml

@@ -0,0 +1,28 @@
+name: API Doc Parsing
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    branches:
+      - LP-55-Backend-Refactor # Temporary. Will be changed to `main` when refactor is complete
+
+jobs:
+  generate-api-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          path: moodle
+
+      - name: Setup Python
+        uses: actions/setup-python@v4.7.1
+        with:
+          python-version: '3.12'
+
+      - name: Generate docs
+        working-directory: moodle
+        run: python document_services.py -

.gitignore

@@ -1,3 +1,5 @@
 moodle
 *.zip
 lbplanner.dart/test/env.dart
+example
+.idea

.kateproject

@@ -0,0 +1,9 @@
+{
+	"lspclient": {
+		"servers": {
+			"php" : {
+				"root": "../moodle/"
+			}
+		}
+	}
+}