.prettierrc.json

@@ -2,11 +2,9 @@
   "trailingComma": "es5",
   "overrides": [
     {
-      "files": "*.php",
+      "files": ["*.md", "*.mdx"],
       "options": {
-        "phpVersion": "7.2",
-        "singleQuote": true,
-        "trailingCommaPHP": true
+        "proseWrap": "always"
       }
     }
   ]

.releaserc.json

+{
+  "branches": [
+    "main",
+    {
+      "name": "alpha",
+      "prerelease": true
+    },
+    {
+      "name": "beta",
+      "prerelease": true
+    },
+    {
+      "name": "next",
+      "prerelease": true
+    }
+  ],
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits",
+        "releaseRules": [
+          {
+            "type": "docs",
+            "scope": "README",
+            "release": "patch"
+          },
+          {
+            "type": "refactor",
+            "scope": "core-*",
+            "release": "minor"
+          },
+          {
+            "type": "refactor",
+            "release": "patch"
+          }
+        ],
+        "parserOpts": {
+          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
+        }
+      }
+    ],
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        "preset": "conventionalcommits",
+        "parserOpts": {
+          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
+        },
+        "presetConfig": {
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "chore",
+              "section": "Internal",
+              "hidden": false
+            },
+            {
+              "type": "refactor",
+              "section": "Internal",
+              "hidden": false
+            },
+            {
+              "type": "perf",
+              "section": "Internal",
+              "hidden": false
+            }
+          ]
+        }
+      }
+    ],
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/exec",
+      {
+        "prepareCmd": "./scripts/bundle.sh ${nextRelease.version} && ./scripts/package.sh ${nextRelease.version} && pnpm exec prettier --write CHANGELOG.md"
+      }
+    ],
+    "@semantic-release/npm",
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "app/Config/Constants.php",
+          "composer.json",
+          "package.json",
+          "package-lock.json",
+          "CHANGELOG.md"
+        ]
+      }
+    ],
+    [
+      "@semantic-release/gitlab",
+      {
+        "gitlabUrl": "https://code.castopod.org/",
+        "assets": [
+          {
+            "path": "castopod-*.zip",
+            "label": "Castopod Package (zip)"
+          },
+          {
+            "path": "castopod-*.tar.gz",
+            "label": "Castopod Package (tar.gz)"
+          }
+        ]
+      }
+    ]
+  ]
+}

.rsync-filter

+# rsync filter rules to copy required files for Castopod's bundle
+
++ resources/icons/***
+- resources/**
++ app/***
++ modules/***
++ plugins/***
++ public/***
++ themes/***
++ vendor/***
++ writable/***
++ .env.example
++ LICENSE.md
++ README.md
++ spark
++ php-icons.php
+- **

.stylelintrc.json

+{
+  "extends": "stylelint-config-standard",
+  "rules": {
+    "at-rule-no-unknown": [
+      true,
+      {
+        "ignoreAtRules": [
+          "tailwind",
+          "apply",
+          "responsive",
+          "variants",
+          "screen",
+          "layer",
+          "config"
+        ]
+      }
+    ],
+    "at-rule-no-deprecated": [
+      true,
+      {
+        "ignoreAtRules": ["apply"]
+      }
+    ],
+    "function-no-unknown": [
+      true,
+      {
+        "ignoreFunctions": ["theme"]
+      }
+    ],
+    "no-descending-specificity": null,
+    "selector-class-pattern": null
+  }
+}

.svgo.cjs

+module.exports = {
+  plugins: [
+    {
+      name: "removeViewBox",
+      active: false,
+    },
+    "removeXMLNS",
+    "removeDimensions",
+    "sortAttrs",
+    "prefixIds",
+  ],
+};

.svgo.icons.cjs

+module.exports = {
+  plugins: [
+    "removeXMLNS",
+    "removeDimensions",
+    "sortAttrs",
+    {
+      name: "addAttributesToSVGElement",
+      params: {
+        attributes: [
+          { fill: "currentColor" },
+          { width: "1em" },
+          { height: "1em" },
+        ],
+      },
+    },
+  ],
+};

AUTHORS.md

 # Authors
 
-- [Benjamin Bellamy](https://code.podlibre.org/benjamin) <ben@podlibre.org>
-- [Yassine Doghri](https://code.podlibre.org/yassine) <yassine@podlibre.org>
+- [Benjamin Bellamy](https://code.castopod.org/benjamin) <ben@castopod.org>
+- [Yassine Doghri](https://code.castopod.org/yassine) <yassine@castopod.org>

CODE_OF_CONDUCT.md

+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[abuse@castopod.org](mailto:abuse@castopod.org). All complaints will be reviewed
+and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING-DEV.md

+# Setup your development environment
+
+## Introduction
+
+Castopod is a web app based on the `php` framework
+[CodeIgniter 4](https://codeigniter.com).
+
+We use [Docker](https://www.docker.com/) to quickly setup a dev environment. A
+`docker-compose.yml` and `Dockerfile` are included in the project's root folder
+to help you kickstart your contribution.
+
+> You don't need any prior knowledge of Docker to follow the next steps.
+> However, if you wish to use your own environment, feel free to do so!
+
+## Setup instructions
+
+### 1. Pre-requisites
+
+0. Install [Docker](https://docs.docker.com/get-docker).
+
+1. Clone the Castopod repository by running:
+
+   ```bash
+   git clone https://code.castopod.org/adaures/castopod.git
+   ```
+
+2. Create a `.env` file with the minimum required config to connect the app to
+   the database and use redis as a cache handler:
+
+   ```ini
+   CI_ENVIRONMENT="development"
+   # If set to development, you must run `pnpm run dev` to start the static assets server
+   vite.environment="development"
+
+   # By default, this is set to true in the app config.
+   # For development, this must be set to false as it is
+   # on a local environment
+   app.forceGlobalSecureRequests=false
+
+   app.baseURL="http://localhost:8080/"
+
+   admin.gateway="cp-admin"
+   auth.gateway="cp-auth"
+
+   database.default.hostname="mariadb"
+   database.default.database="castopod"
+   database.default.username="castopod"
+   database.default.password="castopod"
+   database.default.DBPrefix="dev_"
+
+   analytics.salt="DEV_ANALYTICS_SALT"
+
+   cache.handler="redis"
+   cache.redis.host="redis"
+
+   # You may not want to use redis as your cache handler
+   # Comment/remove the two lines above and uncomment
+   # the next line for file caching.
+   # -----------------------
+   #cache.handler="file"
+
+   ######################################
+   # Media config
+   ######################################
+   media.baseURL="http://localhost:8080/"
+
+   # S3
+   # Uncomment to store s3 objects using adobe/s3mock service
+   # -----------------------
+   #media.fileManager="s3"
+   #media.s3.bucket="castopod"
+   #media.s3.endpoint="http://172.31.0.6:9090/"
+   #media.s3.pathStyleEndpoint=true
+   ```
+
+   > [!NOTE]  
+   > You can tweak your environment by setting more environment variables in
+   > your custom `.env` file. See the `env` for examples or the
+   > [CodeIgniter4 User Guide](https://codeigniter.com/user_guide/index.html)
+   > for more info.
+
+3. (for Docker desktop) Add the repository you've cloned to Docker desktop's
+   `Settings` > `Resources` > `File Sharing`
+
+### 2. (recommended) Develop inside the app container with VSCode
+
+If you're working in VSCode, you can take advantage of the `.devcontainer/`
+folder. It defines a development environment (dev container) with preinstalled
+requirements and VSCode extensions so you don't have to worry about them. All
+required services will be loaded automagically! 🪄
+
+1. Install the VSCode extension
+   [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+2. `Ctrl/Cmd + Shift + P` > `Open in container`
+
+   > The VSCode window will reload inside the dev container. Expect several
+   > minutes during first load as it is building all necessary services.
+
+   **Note**: The dev container will start by running Castopod's PHP server.
+   During development, you will have to start [Vite](https://vitejs.dev)'s dev
+   server for compiling the typescript code and styles:
+
+   ```bash
+   # run Vite dev server
+   pnpm run dev
+   ```
+
+   If there is any issue with the PHP server not running, you can restart them
+   using the following commands:
+
+   ```bash
+   # run Castopod server
+   php spark serve - 0.0.0.0
+   ```
+
+3. You're all set! 🎉
+
+   You're now **inside the dev container**, you may use the VSCode console
+   (`Terminal` > `New Terminal`) to run any command:
+
+   ```bash
+   # PHP is installed
+   php -v
+
+   # Composer is installed
+   composer -V
+
+   # pnpm is installed
+   pnpm -v
+
+   # git is installed
+   git version
+   ```
+
+For more info, see
+[Developing inside a Container](https://code.visualstudio.com/docs/devcontainers/containers)
+
+### 3. Start hacking
+
+You're all set! Start working your magic by updating the project's files! Help
+yourself to the
+[CodeIgniter4 User Guide](https://codeigniter.com/user_guide/index.html) for
+more insights.
+
+To see your changes, go to:
+
+- `http://localhost:8080/` for the Castopod website
+- `http://localhost:8080/cp-admin` for the Castopod admin:
+
+  - email: **admin@castopod.local**
+  - password: **castopod**
+
+- `http://localhost:8888/` for the phpmyadmin interface:
+
+  - username: **castopod**
+  - password: **castopod**
+
+### 2-alt. Develop outside the app container
+
+You do not wish to use the VSCode devcontainer? No problem!
+
+1. Start the Docker containers manually:
+
+   Go to the project's root folder and run:
+
+   ```bash
+   # starts all services declared in docker-compose.yml file
+   # -d option starts the containers in the background
+   docker-compose up -d
+
+   # See all running processes (you should see 3 processes running)
+   docker-compose ps
+
+   # Alternatively, you can check all docker processes
+   docker ps -a
+
+   ```
+
+   > The `docker-compose up -d` command will boot 5 containers in the
+   > background:
+   >
+   > - `castopod_app`: a php based container with Castopod requirements
+   >   installed
+   > - `castopod_redis`: a [redis](https://redis.io/) database to handle queries
+   >   and pages caching
+   > - `castopod_mariadb`: a [mariadb](https://mariadb.org/) server for
+   >   persistent data
+   > - `castopod_phpmyadmin`: a phpmyadmin server to visualize the mariadb
+   >   database.
+   > - `castopod_s3`: a mock s3 server to work on the s3 fileManager
+
+2. Run any command inside the containers by prefixing them with
+   `docker-compose run --rm app`:
+
+   ```bash
+   # use PHP
+   docker-compose run --rm app php -v
+
+   # use Composer
+   docker-compose run --rm app composer -V
+
+   # use pnpm
+   docker-compose run --rm app pnpm -v
+
+   # use git
+   docker-compose run --rm app git version
+   ```
+
+---
+
+## Going Further
+
+### Install Castopod's dependencies
+
+1. Install php dependencies with [Composer](https://getcomposer.org/)
+
+   ```bash
+   composer install
+   ```
+
+   > [!NOTE]  
+   > The php dependencies aren't included in the repository. Composer will check
+   > the `composer.json` and `composer.lock` files to download the packages with
+   > the right versions. The dependencies will live under the `vendor/` folder.
+   > For more info, check out the
+   > [Composer documentation](https://getcomposer.org/doc/).
+
+2. Install JavaScript dependencies with [pnpm](https://pnpm.io/)
+
+   ```bash
+   pnpm install
+   ```
+
+   > [!NOTE]  
+   > The JavaScript dependencies aren't included in the repository. Pnpm will
+   > check the `package.json` and `pnpm-lock.yaml` files to download the
+   > packages with the right versions. The dependencies will live under the
+   > `node_module` folder. For more info, check out the
+   > [PNPM documentation](https://pnpm.io/motivation).
+
+3. Generate static assets:
+
+   ```bash
+   # build all static assets at once
+   pnpm run build:static
+
+   # build specific assets
+   pnpm run build:icons
+   pnpm run build:svg
+   ```
+
+   > [!NOTE]  
+   > The static assets generated live under the `public/assets` folder, it
+   > includes JavaScript, styles, images, fonts, icons and svg files.
+
+### Initialize and populate database
+
+> [!TIP]  
+> You may skip this section if you go through the install wizard (go to
+> `/cp-install`).
+
+1. Build the database with the migrate command:
+
+   ```bash
+   # loads the database schema during first migration
+   php spark migrate -all
+   ```
+
+   You may need to undo the migration (rollback):
+
+   ```bash
+   # rolls back database schema (deletes all tables and their content)
+   php spark migrate:rollback
+   ```
+
+2. Populate the database with the required data:
+
+   ```bash
+   # Populates all required data
+   php spark db:seed DevSeeder
+   ```
+
+   You may choose to add data separately:
+
+   ```bash
+   # Populates all categories
+   php spark db:seed CategorySeeder
+
+   # Populates all Languages
+   php spark db:seed LanguageSeeder
+
+   # Adds a superadmin with [admin@castopod.local / castopod] credentials
+   php spark db:seed DevSuperadminSeeder
+   ```
+
+3. (optional) Populate the database with test data:
+
+   - Populate with fake podcast analytics:
+
+   ```bash
+   php spark db:seed FakePodcastsAnalyticsSeeder
+   ```
+
+   - Populate with fake website analytics:
+
+   ```bash
+   php spark db:seed FakeWebsiteAnalyticsSeeder
+   ```
+
+### Useful docker / docker-compose commands
+
+- Monitor the app container:
+
+```bash
+docker-compose logs --tail 50 --follow --timestamps app
+```
+
+- Interact with the Redis server using included redis-cli command:
+
+```bash
+docker exec -it castopod_redis redis-cli
+```
+
+- Monitor the Redis container:
+
+```bash
+docker-compose logs --tail 50 --follow --timestamps redis
+```
+
+- Monitor the mariadb container:
+
+```bash
+docker-compose logs --tail 50 --follow --timestamps mariadb
+```
+
+- Monitor the phpmyadmin container:
+
+```bash
+docker-compose logs --tail 50 --follow --timestamps phpmyadmin
+```
+
+- Restart docker containers:
+
+```bash
+docker-compose restart
+```
+
+- Destroy all containers, opposite of `up` command:
+
+```bash
+docker-compose down
+```
+
+- Rebuild app container:
+
+```bash
+docker-compose build app
+```
+
+Check [Docker](https://docs.docker.com/engine/reference/commandline/docker/) and
+[docker-compose](https://docs.docker.com/compose/reference/) documentations for
+more insights.
+
+### Updating Documentation
+
+Castopod's documentation is written in Markdown and uses the Astro Starlight
+framework. To update Castopod's documentation, including the Getting Started
+guide and User Guide:
+
+1. Change directories to the `docs` directory and install the dependencies:
+
+   ```bash
+   cd docs/
+   pnpm i
+   ```
+
+2. Start the documentation development server:
+
+   ```bash
+   pnpm run dev --host
+   ```
+
+3. The documentation development server runs on port 4321. In your browser visit
+   `http://localhost:4321/docs`. If the page displays a 404 Not Found error,
+   click on the Castopod logo in the upper left hand corner of the page and the
+   documentation should load.
+
+4. Edit the Markdown files with your documentation updates. The Astro Starlight
+   development server will automatically update each time you save a change.
+
+## Known issues
+
+### Allocation failed - JavaScript heap out of memory
+
+This happens when running `pnpm install`.
+
+👉 By default, docker might not have access to enough RAM. Allocate more memory
+and run `pnpm install` again.
+
+### (Linux) Files created inside container are attributed to root locally
+
+You may use Linux user namespaces to fix this on your machine:
+
+> [!NOTE]  
+> Replace "username" with your local username
+
+1. Go to `/etc/docker/daemon.json` and add:
+
+   ```json
+   {
+     "userns-remap": "username"
+   }
+   ```
+
+2. Configure the subordinate uid/guid:
+
+   ```bash
+   # in /etc/subuid
+   username:1000:1
+   username:100000:65536
+   ```
+
+   ```bash
+   # in /etc/subgid
+   username:1000:1
+   username:100000:65536
+   ```
+
+3. Restart Docker:
+
+   ```bash
+   sudo systemctl restart docker
+   ```
+
+4. That's it! Now, the root user in the container will be mapped to the user on
+   your local machine, no more permission issues! 🎉
+
+You can check
+[this great article](https://www.jujens.eu/posts/en/2017/Jul/02/docker-userns-remap/)
+to know more about how it works.

CONTRIBUTING.md

+# Contributing to Castopod
+
+Love Castopod and want to help? Thanks so much, there's something to do for
+everybody!
+
+> [!NOTE]  
+> Castopod follows the [all contributors](https://allcontributors.org/)
+> specification in an effort to **recognize any kind of contribution**, not just
+> code!  
+> If you've made a contribution and do not appear in the
+> [contributors](../index.md#contributors-✨) list, please
+> [let us know](../index.md#contact) so we can correct our mistake! 🙂
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of the
+developers managing and developing this open source project. In return, they
+should reciprocate that respect in addressing your issue or assessing patches
+and features.
+
+## Translating Castopod
+
+We use [Crowdin](https://translate.castopod.org/) to manage translation files
+for [Castopod](https://code.castopod.org/), the
+[documentation](https://docs.castopod.org/) and the
+[landing](https://castopod.org/) websites.
+
+Whether you'd like to correct a translation error, validate new translations or
+include your language to Castopod, head into the
+[crowdin project](https://translate.castopod.org/) to get started.
+
+> [!NOTE]  
+> To prevent degrading user experience, new languages are included to Castopod
+> when they reach a certain threshold (~90%).
+
+## Using the issue tracker
+
+The [issue tracker](https://code.castopod.org/adaures/castopod/-/issues) is the
+preferred channel for [bug reports](#bug-reports),
+[features requests](#feature-requests) and
+[submitting pull requests](#pull-requests).
+
+## ⚠️ Security issues and vulnerabilities
+
+If you encounter any security issue or vulnerability in the Castopod source,
+please contact us directly by email at
+[security@castopod.org](mailto:security@castopod.org)
+
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the issue search** — check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** — try to reproduce it using the
+   latest `main` branch in the repository.
+
+3. **Isolate the problem** — ideally create a
+   [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live
+   example.
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What browser(s) and OS
+experience the problem? What would you expect to be the outcome? All these
+details will help people to fix any potential bugs.
+
+> [!NOTE]  
+> [Issue templates](https://docs.gitlab.com/ee/user/project/description_templates.html#using-the-templates) have
+> been created for this project. You may use them to help you follow those
+> guidelines.
+
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to _you_ to make a strong
+case to convince the project's developers of the merits of this feature. Please
+provide as much detail and context as possible.
+
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic help.
+They should remain focused in scope and avoid containing unrelated commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code, porting to a different language),
+otherwise you risk spending a lot of time working on something that the
+project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+Adhering to the following process is the best way to get your work included in
+the project:
+
+1. [Fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html)
+   the project, clone your fork, and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://code.castopod.org/<your-username>/castopod.git
+
+   # Navigate to the newly cloned directory
+   cd castopod
+
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://code.castopod.org/adaures/castopod.git
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout main
+   git pull upstream main
+   ```
+
+3. Create a new topic branch (off the `main` branch) to contain your feature,
+   change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Please adhere to these
+   [git commit message guidelines](https://conventionalcommits.org/) or your
+   code is unlikely be merged into the main project. Use Git's
+   [interactive rebase](https://help.github.com/articles/about-git-rebase/)
+   feature to tidy up your commits before making them public.
+
+5. Locally merge (or rebase) the upstream dev branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream main
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html#new-merge-request-from-a-fork)
+   with a clear title and description.
+
+> [!IMPORTANT]  
+> By submitting a patch, you agree to allow the project owners to license your
+> work under the terms of the
+> [GNU AGPLv3](https://code.castopod.org/adaures/castopod/-/blob/develop/LICENSE.md).
+
+## Collaborating guidelines
+
+There are few basic rules to ensure high quality of the project:
+
+- Before merging, a PR requires at least two approvals from the collaborators
+  unless it's an architectural change, a large feature, etc. If it is, then at
+  least 50% of the core team have to agree to merge it, with every team member
+  having a full veto right. (i.e. every single one can block any PR)
+- A PR should remain open for at least two days before merging (does not apply
+  for trivial contributions like fixing a typo). This way everyone has enough
+  time to look into it.
+
+You are always welcome to discuss and propose improvements to this guideline.

DEPENDENCIES.md

@@ -2,14 +2,29 @@
 
 Castopod uses the following components:
 
-- [Code Igniter 4](https://codeigniter.com) ([MIT License](https://codeigniter.com/user_guide/license.html))
-- [tailwindcss](https://tailwindcss.com/) ([MIT License](https://github.com/tailwindcss/tailwindcss/blob/master/LICENSE))
-- [Tatter\Relations](https://github.com/tattersoftware/codeigniter4-relations) ([MIT License](https://github.com/tattersoftware/codeigniter4-relations/blob/develop/LICENSE))
-- [D3: Data-Driven Documents](https://github.com/d3/d3) ([BSD 3-Clause "New" or "Revised" License](https://github.com/d3/d3/blob/master/LICENSE))
-- [Rollup](https://github.com/rollup/rollup) ([MIT license](https://github.com/rollup/rollup/blob/master/LICENSE.md))
-- [Svelte](https://github.com/sveltejs/svelte) ([MIT license](https://github.com/sveltejs/svelte/blob/master/LICENSE))
-- [User agent list](https://github.com/opawg/user-agents) ([by Open Podcast Analytics Working Group](https://github.com/opawg)) ([MIT license](https://github.com/opawg/user-agents/blob/master/LICENSE))
-- [WhichBrowser/Parser-PHP](https://github.com/WhichBrowser/Parser-PHP) ([MIT License](https://github.com/WhichBrowser/Parser-PHP/blob/master/LICENSE))
-- [GeoIP2 PHP API](https://github.com/maxmind/GeoIP2-php) ([Apache License 2.0](https://github.com/maxmind/GeoIP2-php/blob/master/LICENSE))
-- [Quill Rich Text Editor](https://github.com/quilljs/quill) ([BSD 3-Clause "New" or "Revised" License](https://github.com/quilljs/quill/blob/develop/LICENSE))
-- [getID3](https://github.com/JamesHeinrich/getID3) ([GNU General Public License v3](https://github.com/JamesHeinrich/getID3/blob/2.0/licenses/license.gpl-30.txt))
+## PHP Dependencies
+
+PHP dependencies can be found in the [composer.json](./composer.json) file.
+
+## Javascript dependencies
+
+Javascript dependencies can be found in the [package.json](./package.json) file.
+
+## Other dependencies
+
+- [Kumbh Sans](https://fonts.google.com/specimen/Kumbh+Sans)
+  ([Open Font License](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL))
+- [Inter](https://fonts.google.com/specimen/Inter)
+  ([Open Font License](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL))
+- [RemixIcon](https://remixicon.com/)
+  ([Apache License 2.0](https://github.com/Remix-Design/RemixIcon/blob/master/License))
+- [OPAWG/User agent list](https://github.com/opawg/user-agents-v2)
+  ([by Open Podcast Analytics Working Group](https://github.com/opawg))
+  ([MIT license](https://github.com/opawg/user-agents-v2/blob/master/LICENSE))
+- [OPAWG/podcast-rss-useragents](https://github.com/opawg/podcast-rss-useragents)
+  ([by Open Podcast Analytics Working Group](https://github.com/opawg))
+  ([MIT license](https://github.com/opawg/podcast-rss-useragents/blob/master/LICENSE))
+- [client9/ipcat](https://github.com/client9/ipcat)
+  ([GNU General Public License v3.0](https://github.com/client9/ipcat/blob/master/LICENSE))
+- [GeoLite2 City](https://dev.maxmind.com/geoip/geoip2/geolite2/)
+  ([Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](https://www.maxmind.com/en/geolite2/eula))

Dockerfile

-FROM php:latest
-
-COPY . /castopod
-WORKDIR /castopod
-
-### Install CodeIgniter's server requirements
-#-- https://github.com/codeigniter4/appstarter#server-requirements
-
-# Install intl extension using https://github.com/mlocati/docker-php-extension-installer
-RUN apt-get update && apt-get install -y \
-    libicu-dev \
-    libpng-dev \
-    zlib1g-dev \
-    && docker-php-ext-install intl gd
-
-RUN docker-php-ext-install mysqli && docker-php-ext-enable mysqli
-
-RUN echo "file_uploads = On\n" \
-         "memory_limit = 100M\n" \
-         "upload_max_filesize = 100M\n" \
-         "post_max_size = 120M\n" \
-         > /usr/local/etc/php/conf.d/uploads.ini

GDPR.txt

+# This file lists processing purposes and the personal data gathered by
+# Castopod.
+# It is intended for hosting providers who want to provide a service
+# based on Castopod, helping them to comply with GDPR requirements. Note
+# that the services powered by Castopod may collect more data, HTTP logs
+# in particular. As a hosting provider, you must inform your users of their
+# rights and how their data are used and protected.
+
+purpose:
+    Deduplicate number of audio file downloads made by the same listener
+    for analytics purposes
+lawfulness: legitimate interest
+
+data: (User IP address + Browser User Agent)
+required: yes
+visibility: none
+description:
+    In order to produce analytics data comparable to the podcasting
+    ecosystem standards, the User IP address (REMOTE_ADDR) with the
+    browser User Agent (HTTP_USER_AGENT) are stored when an audio file
+    is downloaded.
+mitigation:
+    The data (User IP address + Browser User Agent) is never stored in plain
+    format.
+    The data is concatenated with a cryptographic salt, the current date,
+    and the podcast or episode IDs.
+    The data is hashed (using sha1) after being concatenated and before
+    being stored.
+    The data is stored in a cache database (eg. Redis).
+    The data expires every day at midnight (server time).
+
+purpose: Connect users to their accounts
+lawfulness: legitimate interest
+
+data: username
+required: yes
+visibility: authenticated users
+description:
+    The username is used to identify users during the login process.
+    The username is only required for users accessing the admin area.
+mitigation:
+    The username does not have to be a real or known identity.
+
+data: user e-mail address
+required: yes
+visibility: administrators
+description:
+    The e-mail address is used for administrative purposes, to identify users
+    during the login process and in case of forgotten password.
+
+data: password
+required: yes
+visibility: private
+description:
+    The password is used to check the identity of users during the login
+    process.
+mitigation:
+    Only hashes (using the Argon2 key derivation function) of the passwords
+    are stored in the database (but they transit over the network).
+
+purpose: Claim ownership of a podcast
+lawfulness: legitimate interest
+
+data: Podcast e-mail address
+required: yes
+visibility: public
+description:
+    The podcast e-mail address is used to claim podcast ownership on other
+    platforms (such as Apple Podcasts).
+mitigation:
+    The e-mail can be generic.
+
+purpose: Grant access to premium content
+lawfulness: legitimate interest
+
+data: Subscriber's email address
+required: yes
+visibility: administrators
+description:
+    The subscriber's e-mail address is used to provide credentials for
+    listening to premium content.
+mitigation:
+    The e-mail can be generic.

app/.htaccess

-<IfModule authz_core_module>
-    Require all denied
-</IfModule>
-<IfModule !authz_core_module>
-    Deny from all
-</IfModule>
+<IfModule authz_core_module> Require all denied </IfModule>
+<IfModule !authz_core_module> Deny from all </IfModule>

app/Commands/EpisodesComputeDownloads.php

+<?php
+
+declare(strict_types=1);
+
+namespace App\Commands;
+
+use App\Models\EpisodeModel;
+use CodeIgniter\CLI\BaseCommand;
+
+class EpisodesComputeDownloads extends BaseCommand
+{
+    /**
+     * The Command's Group
+     *
+     * @var string
+     */
+    protected $group = 'Episodes';
+
+    /**
+     * The Command's Name
+     *
+     * @var string
+     */
+    protected $name = 'episodes:compute-downloads';
+
+    /**
+     * The Command's Description
+     *
+     * @var string
+     */
+    protected $description = "Calculates all episodes downloads and stores results in episodes' downloads_count field.";
+
+    /**
+     * Actually execute a command.
+     */
+    public function run(array $params): void
+    {
+        $episodesModel = new EpisodeModel();
+        $query = $episodesModel->builder()
+            ->select('episodes.id as id, IFNULL(SUM(ape.hits),0) as downloads_count')
+            ->join('analytics_podcasts_by_episode ape', 'episodes.id=ape.episode_id', 'left')
+            ->groupBy('episodes.id');
+
+        $episodeModel2 = new EpisodeModel();
+        $episodeModel2->builder()
+            ->setQueryAsData($query)
+            ->onConstraint('id')
+            ->updateBatch();
+    }
+}

app/Common.php

 <?php
 
+declare(strict_types=1);
+
+use ViewThemes\Theme;
+
 /**
- * The goal of this file is to allow developers a location
- * where they can overwrite core procedural functions and
- * replace them with their own. This file is loaded during
- * the bootstrap process and is called during the frameworks
+ * The goal of this file is to allow developers a location where they can overwrite core procedural functions and
+ * replace them with their own. This file is loaded during the bootstrap process and is called during the framework's
  * execution.
  *
- * This can be looked at as a `master helper` file that is
- * loaded early on, and may also contain additional functions
+ * This can be looked at as a `master helper` file that is loaded early on, and may also contain additional functions
  * that you'd like to use throughout your entire application
  *
- * @link: https://codeigniter4.github.io/CodeIgniter4/
+ * @see: https://codeigniter.com/user_guide/extending/common.html
  */
+
+if (! function_exists('view')) {
+    /**
+     * Grabs the current RendererInterface-compatible class and tells it to render the specified view. Simply provides a
+     * convenience method that can be used in Controllers, libraries, and routed closures.
+     *
+     * NOTE: Does not provide any escaping of the data, so that must all be handled manually by the developer.
+     *
+     * @param array<string, mixed>  $data
+     * @param array<string, mixed>  $options Unused - reserved for third-party extensions.
+     */
+    function view(string $name, array $data = [], array $options = []): string
+    {
+        if (array_key_exists('theme', $options)) {
+            Theme::setTheme($options['theme']);
+        }
+
+        $path = Theme::path();
+
+        /** @var CodeIgniter\View\View $renderer */
+        $renderer = single_service('renderer', $path);
+
+        $saveData = config('View')
+            ->saveData;
+
+        if (array_key_exists('saveData', $options)) {
+            $saveData = (bool) $options['saveData'];
+            unset($options['saveData']);
+        }
+
+        return $renderer->setData($data, 'raw')
+            ->render($name, $options, $saveData);
+    }
+}