├── .gitignore ├── .github ├── FUNDING.yml └── workflows │ └── ci.yml ├── scripts ├── runngrok.sh └── switchphp.sh ├── setup ├── mariadb.sh ├── pgsql.sh ├── mysqli.sh ├── sqlsrv.sh ├── chromedriver.sh └── oci8.sh ├── config-dist.sh ├── README.md ├── conf └── apache2 │ └── sites-available │ └── moodle.conf ├── setup.sh └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea/ 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: junpataleta 2 | buy_me_a_coffee: jpataleta 3 | -------------------------------------------------------------------------------- /scripts/runngrok.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ~/apps/ngrok http 80 -region=au 4 | 5 | -------------------------------------------------------------------------------- /setup/mariadb.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source "$(pwd)/config.sh" 4 | 5 | docker run --detach --name mariadb${MARIADB_TAG} -e MARIADB_ROOT_PASSWORD=${MARIADB_PASSWD} -p ${MARIADB_PORT}:3306 mariadb:${MARIADB_TAG} 6 | -------------------------------------------------------------------------------- /setup/pgsql.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source "$(pwd)/config.sh" 4 | 5 | sudo apt install -y postgresql-client 6 | 7 | docker run --name pgsql${PGSQL_TAG} -e POSTGRES_PASSWORD=${PGSQL_PASSWD} -p 5432:5432 -d postgres:${PGSQL_TAG} 8 | -------------------------------------------------------------------------------- /setup/mysqli.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source "$(pwd)/config.sh" 4 | 5 | sudo apt install -y mysql-client 6 | 7 | docker run --name mysqli${MYSQLI_TAG} -e MYSQL_ROOT_PASSWORD=${MYSQLI_PASSWD} -p ${MYSQLI_PORT}:3306 -d mysql:${MYSQLI_TAG} 8 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | # This is a basic workflow to help you get started with Actions 2 | 3 | name: CI 4 | 5 | # Controls when the workflow will run 6 | on: 7 | # Triggers the workflow on push or pull request events but only for the "main" branch 8 | push: 9 | branches: [ "main" ] 10 | pull_request: 11 | branches: [ "main" ] 12 | 13 | # Allows you to run this workflow manually from the Actions tab 14 | workflow_dispatch: 15 | 16 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 17 | jobs: 18 | # This workflow contains a single job called "build" 19 | build: 20 | # The type of runner that the job will run on 21 | runs-on: ${{ matrix.os }} 22 | strategy: 23 | matrix: 24 | os: 25 | - ubuntu-22.04 26 | - ubuntu-24.04 27 | 28 | # Steps represent a sequence of tasks that will be executed as part of the job 29 | steps: 30 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it 31 | - uses: actions/checkout@v4 32 | 33 | # Runs a single command using the runners shell 34 | - name: Run the installer 35 | run: ${PWD}/setup.sh 36 | -------------------------------------------------------------------------------- /scripts/switchphp.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | if [ -z "$1" ] 4 | then 5 | echo "Please provide a PHP version to switch to (e.g. 7.1)" 6 | exit 1 7 | fi 8 | 9 | # Get the current PHP version. 10 | PHPVER=$(php -v | cut -d' ' -f 2) 11 | # Extract the major version. 12 | MAJORVER=$(echo $PHPVER | cut -d'.' -f 1 -s) 13 | # Extract the minor version. 14 | MINORVER=$(echo $PHPVER | cut -d'.' -f 2 -s) 15 | 16 | OLDVER="$MAJORVER.$MINORVER" 17 | 18 | # Check if we're already on the version we're switching to. 19 | if [ "$1" == "$OLDVER" ] 20 | then 21 | echo "You are already on PHP $1" 22 | exit 1 23 | fi 24 | 25 | echo "Switching to PHP $1 from PHP $OLDVER" 26 | 27 | # Try to enable the new PHP version. 28 | sudo a2enmod php$1 29 | 30 | if [ $? -eq 0 ] 31 | then 32 | # Disable the old PHP version. 33 | sudo a2dismod php$OLDVER 34 | 35 | # Update paths. 36 | sudo update-alternatives --set php /usr/bin/php$1 37 | sudo update-alternatives --set php-config /usr/bin/php-config$1 38 | sudo update-alternatives --set phpize /usr/bin/phpize$1 39 | 40 | # Restart Apache. 41 | sudo service apache2 restart 42 | 43 | echo "You are now using PHP $1" 44 | fi 45 | -------------------------------------------------------------------------------- /setup/sqlsrv.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source "$(pwd)/config.sh" 4 | 5 | # Download Microsoft's key. 6 | sudo wget https://packages.microsoft.com/keys/microsoft.asc -O /usr/share/keyrings/microsoft.asc 7 | 8 | # Update sources.list.d entry. 9 | echo "deb [arch=amd64,armhf,arm64 signed-by=/usr/share/keyrings/microsoft.asc] https://packages.microsoft.com/ubuntu/$(lsb_release -rs)/prod $(lsb_release -cs) main" \ 10 | | sudo tee /etc/apt/sources.list.d/mssql-release.list > /dev/null 11 | 12 | sudo apt update 13 | # For bcp and sqlcmd. 14 | sudo ACCEPT_EULA=Y apt install -y mssql-tools 15 | echo 'export PATH="$PATH:/opt/mssql-tools/bin"' >> ~/.bash_profile 16 | echo 'export PATH="$PATH:/opt/mssql-tools/bin"' >> ~/.bashrc 17 | source ~/.bashrc 18 | sudo apt install -y unixodbc-dev 19 | 20 | # Install php-sqlsrv extension for all supported versions. 21 | cd $APPS_DIR 22 | for phpver in "${PHP_VERSIONS[@]}" 23 | do 24 | ~/apps/switchphp.sh $phpver 25 | 26 | # sudo pecl install sqlsrv 27 | if [ ! -f "$APPS_DIR/sqlsrv-$SQLSRV_VER.tgz" ]; then 28 | wget https://pecl.php.net/get/sqlsrv-$SQLSRV_VER.tgz 29 | fi 30 | if [ ! -d "$APPS_DIR/sqlsrv-$SQLSRV_VER" ]; then 31 | tar -xzf sqlsrv-$SQLSRV_VER.tgz 32 | fi 33 | cd $APPS_DIR/sqlsrv-$SQLSRV_VER 34 | phpize 35 | ./configure 36 | sudo make install -B 37 | sudo bash -c "echo 'extension=sqlsrv.so' > /etc/php/$phpver/mods-available/sqlsrv.ini" 38 | sudo phpenmod -v $phpver sqlsrv 39 | done 40 | # Tidy up. 41 | rm $APPS_DIR/sqlsrv-$SQLSRV_VER.tgz 42 | 43 | # Install SQL Server via docker. 44 | SQLSRV_PASSWD=Moodl3P@ssw0rd 45 | docker run --name sqlsrv -e 'ACCEPT_EULA=Y' -e "SA_PASSWORD=$SQLSRV_PASSWD" -p 1433:1433 -d moodlehq/moodle-db-mssql 46 | 47 | ~/apps/switchphp.sh $DEFAULT_PHP_VERSION 48 | -------------------------------------------------------------------------------- /setup/chromedriver.sh: -------------------------------------------------------------------------------- 1 | source "$(pwd)/config.sh" 2 | 3 | cd $APPS_DIR 4 | 5 | # Download Chrome. 6 | echo "----------------------------------------" 7 | echo "Setting up Chrome..." 8 | echo "----------------------------------------" 9 | wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb 10 | 11 | # Install Chrome. 12 | sudo dpkg -i ./google-chrome-stable_current_amd64.deb 13 | 14 | # Tidy up. 15 | rm ./google-chrome-stable_current_amd64.deb 16 | 17 | # Extract version of Chrome. 18 | CHROME_VER=$(google-chrome --version | cut -d ' ' -f 3 | cut -d '.' -f 1,2,3 --output-delimiter='.') 19 | 20 | echo "----------------------------------------" 21 | echo "Setting up ChromeDriver..." 22 | echo "----------------------------------------" 23 | 24 | # Download/update the latest stable version of Chromedriver. 25 | if [ ! -d "$APPS_DIR/chrome-for-testing" ]; then 26 | git clone https://github.com/GoogleChromeLabs/chrome-for-testing.git 27 | cd $APPS_DIR/chrome-for-testing 28 | nvm install 29 | npm install 30 | else 31 | cd $APPS_DIR/chrome-for-testing 32 | git fetch origin 33 | git reset --hard origin/main 34 | npm install 35 | fi 36 | 37 | CHROMEDRIVER_URL=$(npm run find | grep "$CHROME_VER.*chromedriver-linux64" | cut -d ' ' -f 1) 38 | 39 | cd $APPS_DIR 40 | 41 | # Download the zip file of the chromedriver. 42 | echo "Downloading Chromedriver from $CHROMEDRIVER_URL..." 43 | wget $CHROMEDRIVER_URL 44 | 45 | # Extract it. 46 | unzip -o -p chromedriver-linux64.zip chromedriver-linux64/chromedriver >chromedriver 47 | 48 | # Ensure ChromeDriver is executable. 49 | if [[ ! -x "chromedriver" ]]; then 50 | chmod +x chromedriver 51 | fi 52 | 53 | # Link it to /usr/local/bin, if necessary. 54 | if [ ! -f "/usr/local/bin/chromedriver" ]; then 55 | sudo ln -s "$APPS_DIR/chromedriver" /usr/local/bin/chromedriver 56 | fi 57 | 58 | # Tidy up. 59 | rm chromedriver-linux64.zip 60 | 61 | # Go back to the source home. 62 | cd $SOURCE_HOME 63 | -------------------------------------------------------------------------------- /config-dist.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | export APPS_DIR=$HOME/apps 4 | 5 | # List supported PHP versions of supported Moodle versions (even security ones). 6 | # - 401 supports 7.4 up to 8.1. 7 | # - 404 and 405 support 8.1 up to 8.3. 8 | # - 500 supports 8.2 up to 8.4. 9 | # - 501 supports 8.2 and up. 10 | export PHP_VERSIONS=("7.4" "8.0" "8.1" "8.2" "8.3" "8.4") 11 | export DEFAULT_PHP_VERSION="8.2" 12 | # List required PHP extensions. 13 | export PHP_EXTS=(dev pgsql intl mysqli xml mbstring curl zip gd soap xmlrpc) 14 | 15 | # PostgreSQL variables. 16 | # Minimum supported PostgreSQL version by the main branch. 17 | export PGSQL_TAG=15 18 | # Password. 19 | export PGSQL_PASSWD=moodle 20 | 21 | # MariaDB variables. 22 | # Minimum supported MariaDB version by the main branch. 23 | export MARIADB_TAG=10.11 24 | # Password. 25 | export MARIADB_PASSWD=moodle 26 | export MARIADB_PORT=3306 27 | 28 | # MySQL variables. 29 | # Minimum supported MySQL version by the main branch. 30 | export MYSQLI_TAG=8.4 31 | # Password. 32 | export MYSQLI_PASSWD=moodle 33 | # To use MySQL together with MariaDB, they need to run on different ports. 34 | export MYSQLI_PORT=3307 35 | 36 | # php-sqlsrv extension version. Check https://pecl.php.net/package/sqlsrv. 37 | export SQLSRV_VER=5.10.1 38 | 39 | # Oracle Instantclient URLS (v21.8) 40 | export INSTANTCLIENT_BASIC_URL=https://download.oracle.com/otn_software/linux/instantclient/218000/instantclient-basic-linux.x64-21.8.0.0.0dbru.zip 41 | export INSTANTCLIENT_SDK_URL=https://download.oracle.com/otn_software/linux/instantclient/218000/instantclient-sdk-linux.x64-21.8.0.0.0dbru.zip 42 | export ORACLE_DB_TAG=21 43 | # Change to 1 if you want to install Oracle PHP extensions and run a container via docker during setup. 44 | export INSTALL_ORACLE=0 45 | 46 | # Git variables. Change these variables to configure global Git variables with your details. 47 | export GIT_EMAIL="" 48 | export GIT_NAME="" 49 | 50 | # Variables for MDK. 51 | # Change this to configure MDK with your GitHub username. 52 | export MDK_GITHUB_USER="" 53 | # Change this to configure MDK with your Tracker username. 54 | export MDK_TRACKER_USER="" 55 | # Change this to set the `www` folder for MDK (`dirs.www`). 56 | export MDK_WWW_DIR="" 57 | # Change this to set the `moodles` folder for MDK (`dirs.storage`). 58 | export MDK_MOODLES_DIR="" 59 | -------------------------------------------------------------------------------- /setup/oci8.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source "$(pwd)/config.sh" 4 | 5 | cd ~/Downloads 6 | 7 | # Download Oracle Instantclient Basic package. 8 | wget -O instantclient-basic.zip $INSTANTCLIENT_BASIC_URL 9 | # Download Oracle Instantclient SDK package. 10 | wget -O instantclient-sdk.zip $INSTANTCLIENT_SDK_URL 11 | 12 | # Unzip the instantclient packages. 13 | ORACLE_DIR=/opt/oracle 14 | if [ ! -d "$ORACLE_DIR" ]; then 15 | sudo mkdir $ORACLE_DIR 16 | fi 17 | cd $ORACLE_DIR 18 | sudo unzip ~/Downloads/instantclient-basic.zip 19 | sudo unzip ~/Downloads/instantclient-sdk.zip 20 | 21 | # Update the runtime link path. 22 | INSTANTCLIENT_DIR=$(ls | grep instantclient) 23 | sudo bash -c "echo $ORACLE_DIR/$INSTANTCLIENT_DIR > /etc/ld.so.conf.d/oracle-instantclient.conf" 24 | sudo ldconfig 25 | 26 | cd ~/apps 27 | mkdir oci8 28 | cd oci8 29 | 30 | # Install the oci8 extension for each supported PHP version. 31 | # Check out https://pecl.php.net/package/oci8. 32 | for phpver in "${PHP_VERSIONS[@]}" 33 | do 34 | ~/apps/switchphp.sh $phpver 35 | # Default oci8 version for the latest versions of PHP. 36 | OCI8_VER="" 37 | if [ $(echo "$phpver < 8.0"|bc -l) -eq 1 ]; then 38 | OCI8_VER="-2.2.0" 39 | elif [ $(echo "$phpver == 8.0"|bc -l) -eq 1 ]; then 40 | OCI8_VER="-3.0.1" 41 | elif [ $(echo "$phpver == 8.1"|bc -l) -eq 1 ]; then 42 | OCI8_VER="-3.2.1" 43 | fi 44 | OCI8=oci8$OCI8_VER 45 | echo "Installing OCI8 extension ($OCI8) for PHP $phpver..." 46 | 47 | # Install the oci8 extension via pecl... 48 | # sudo pear config-set php_ini /etc/php/$phpver/php.ini 49 | # sudo pecl config-set bin_dir /usr/bin/ 50 | # sudo bash -c "echo 'instantclient,$ORACLE_DIR/$INSTANTCLIENT_DIR' | pecl install $OCI8" 51 | 52 | # Install oci8 extension via phpize. This seems to work better than using pecl. 53 | wget https://pecl.php.net/get/oci8$OCI8_VER.tgz 54 | 55 | tar -xzf $OCI8.tgz 56 | cd $OCI8 57 | phpize 58 | ./configure -with-oci8=shared,instantclient,$ORACLE_DIR/$INSTANTCLIENT_DIR 59 | sudo make install 60 | 61 | # Create an ini file for the extension. 62 | sudo bash -c "echo 'extension=oci8.so' > /etc/php/$phpver/mods-available/oci8.ini" 63 | 64 | # Enable the OCI8 extension. 65 | echo "Enabling oci8 extension for $phpver..." 66 | sudo phpenmod -v $phpver oci8 67 | 68 | # Tidy up. 69 | cd .. 70 | rm oci8-$OCI8_VER.tgz 71 | done 72 | 73 | # Install an Oracle XE DB via docker. 74 | docker run --name oracle_$ORACLE_DB_TAG -p 1521:1521 moodlehq/moodle-db-oracle-r2:$ORACLE_DB_TAG 75 | 76 | # Tidy up. 77 | echo "Tidying up..." 78 | rm ~/Downloads/instantclient-basic.zip 79 | rm ~/Downloads/instantclient-sdk.zip 80 | 81 | # Switch back to default PHP version. 82 | ~/apps/switchphp.sh $DEFAULT_PHP_VERSION 83 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Build workflow](https://github.com/junpataleta/moodle-ubuntu/actions/workflows/ci.yml/badge.svg) 2 | 3 | # moodle-ubuntu 4 | 5 | A script that sets up a Moodle development environment in Ubuntu 6 | 7 | **Disclaimer:** This is only meant for use on development and testing environments. Do **NOT** use this for production environments! 8 | 9 | ## Setup 10 | 11 | 1. Download and install [Ubuntu Desktop](https://ubuntu.com/download/desktop). 12 | 13 | - If you're setting up an Ubuntu virtual machine using VirtualBox, follow [these instructions](https://ubuntu.com/tutorials/how-to-run-ubuntu-desktop-on-a-virtual-machine-using-virtualbox#1-overview). 14 | 15 | 2. Open a terminal and install `git` 16 | 17 | ```bash 18 | sudo apt update && sudo apt install -y git 19 | ``` 20 | 21 | 3. Clone this repository. 22 | 23 | ```bash 24 | git clone https://github.com/junpataleta/moodle-ubuntu.git 25 | cd moodle-ubuntu 26 | ``` 27 | 28 | - **Note:** If you're using VirtualBox, this is a good point to [take a snapshot](https://docs.oracle.com/en/virtualization/virtualbox/6.0/user/snapshots.html) of the machine first, so it would be easier to reset in case you need to reinstall when the setup script gets updated in the future. 29 | 30 | 4. Copy `config-dist.sh` to `config.sh` and edit the Git-related or MDK-related settings in `config.sh`. 31 | 32 | 5. Run the script 33 | 34 | ```bash 35 | ./setup.sh 36 | ``` 37 | 38 | 6. Grab some coffee, walk the dog, cook your lunch, do the laundry, or whatever.😛 39 | 40 | ## After setup 41 | 42 | After the installation, you should have the following: 43 | 44 | - Apache server 45 | - PHP versions supported by the lowest security-supported version of Moodle and the next major Moodle version (`main`). 46 | - PHP versions supported by [currently supported versions](https://moodledev.io/general/releases): 47 | - PHP 7.4 48 | - PHP 8.0 49 | - PHP 8.1 50 | - PHP 8.2 51 | - PHP 8.3 52 | - PHP 8.4 53 | - To switch PHP versions, open a terminal and run `~/apps/switchphp.sh PHPVER` where `PHPVER` is any of the installed PHP version numbers. e.g. to switch to PHP 8.2 54 | 55 | ```bash 56 | ~/apps/switchphp.sh 8.2 57 | ``` 58 | 59 | - PostgreSQL server version supported by your Ubuntu distribution. 60 | - Username: `postgres` 61 | - Password: `moodle` 62 | - MySQL server version supported by your Ubuntu distribution. 63 | - MDK 64 | - Two instances are created by MDK during setup: 65 | - A `moodle.git` instance based on the `main` branch: `http://localhost/stable_main` 66 | - An `integration.git` instance based on the `main` branch: `http://localhost/integration_main` 67 | - Default `admin` password for both instances is `test`. 68 | - Default database engine is `pgsql`. 69 | - Behat-related stuff: 70 | - [moodle-browser-config](https://github.com/andrewnicols/moodle-browser-config) 71 | - Chromedriver 72 | - Geckodriver 73 | - Selenium 74 | - Just run the command `sel` to start the Selenium server. 75 | - Docker with Docker compose 76 | - Ngrok 77 | - Adminer: `http://localhost/adminer.php` 78 | 79 | Enjoy! 80 | -------------------------------------------------------------------------------- /conf/apache2/sites-available/moodle.conf: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # The file is used to handle Moodle sites served from a sub folder of the domain. 3 | ####################################### 4 | 5 | ####################################### 6 | # Things you need to set up before using this configuration: 7 | # - the path to the location that all of your Moodle sites are in 8 | # - the hostname of your site 9 | ####################################### 10 | 11 | ####################### 12 | # Set the root directory for your Moodle sites. 13 | ####################### 14 | Define DOCROOT /home/moodle/www 15 | 16 | # Update your configuration to match the host name(s) that you use. 17 | # You can have as many as you like and/or require. 18 | ####################### 19 | # UPDATE ME 20 | ServerName localhost 21 | ####################### 22 | 23 | # You can add any aliases you like here too. 24 | # ServerAlias myhostname.example.com 25 | # ServerAlias myotherhostname.example.com 26 | 27 | ####################################### 28 | # End of configuration. 29 | ####################################### 30 | 31 | DocumentRoot "${DOCROOT}" 32 | 33 | # Configure the directory configuration. 34 | 35 | # Do not allow directory listing. 36 | # Allow following symbolic links. 37 | Options FollowSymLinks 38 | 39 | # Do not allow .htaccess files to override settings. 40 | AllowOverride None 41 | 42 | # Allow access to all users. 43 | Require all granted 44 | 45 | 46 | # Set the index file for the Moodle Root. 47 | DirectoryIndex index.php index.html 48 | 49 | 50 | 51 | SetHandler application/x-httpd-php 52 | 53 | 54 | 55 | 56 | # Enable rewrite logging for debugging purposes. 57 | # LogLevel warn mod_rewrite.c:trace7 58 | 59 | # Use mod_rewrite to handle requests. 60 | # We cannot use FallbackResource here because we need to check if the /public folder exists. 61 | RewriteEngine On 62 | 63 | ##################### 64 | # Ruleset 1. 65 | # Check if this request is for a site which has a public folde.r 66 | ##################### 67 | # Check whether the requested file exists as-is. 68 | RewriteCond %{SCRIPT_FILENAME} !-f 69 | # Extract the top-level folder from the request URI. This is the Moodle site name. 70 | RewriteCond %{REQUEST_FILENAME} ^/([^/]+)(/.*)?$ 71 | # If the public folder exists for that site, rewrite the request to go through it. 72 | RewriteCond %{DOCUMENT_ROOT}/%1/public -d 73 | RewriteRule ^/([^/]+)(/.*)?$ /$1/public$2 [C] # Rewrite to public folder - CHAIN to the next rule. 74 | 75 | ##################### 76 | # Ruleset 1.1. 77 | # The public folder exists. 78 | # See if we can access the file directly. 79 | # If not, rewrite to the r.php (router) inside the site/public folder. 80 | ##################### 81 | # Extract the file path before the .php extension, if any (pathinfo removed). 82 | RewriteCond %{REQUEST_FILENAME} ^(.+\.php)?(/.*)?$ 83 | # AND the requested file does not exist as-is. 84 | # The %1 is the file path before the .php extension, if any (pathinfo removed). 85 | # It is fetched from the RewriteCond above. 86 | # %2 is the pathinfo, if any. 87 | RewriteCond %{DOCUMENT_ROOT}%1 !-f 88 | # AND the requested URI is not a file. 89 | # $1 is the site name, $2 is the file path. 90 | # These come from the RewriteRule below that this rule applies to. 91 | RewriteCond %{DOCUMENT_ROOT}/$1$2 !-f 92 | # AND the requested URI is not a directory. 93 | RewriteCond %{DOCUMENT_ROOT}/$1$2 !-d 94 | # Rewrite the request to go through the r.php (router) in the site/public folder. 95 | RewriteRule ^/([^/]+)(/.*)?$ /$1/public/r.php [L] 96 | 97 | ##################### 98 | # Rule set 2. 99 | # The public folder does _not_ exist. 100 | # See if we can access the file directly. 101 | # If not, rewrite to the r.php (router) in the site folder. 102 | ##################### 103 | # Check whether the requested file exists as-is. 104 | RewriteCond %{SCRIPT_FILENAME} !-f 105 | # Extract the top-level folder from the request URI. This is the Moodle site name. 106 | RewriteCond %{REQUEST_FILENAME} ^/([^/]+)(/.*)?$ 107 | # If the public folder DOES NOT exist for that site. 108 | RewriteCond %{DOCUMENT_ROOT}/%1/public !-d 109 | # Extract the file path before the .php extension, if any (pathinfo removed). 110 | RewriteCond %{REQUEST_FILENAME} ^(.+\.php)?(/.*)?$ 111 | # AND the requested file does not exist as-is. 112 | # The %1 is the file path before the .php extension, if any (pathinfo removed). 113 | # It is fetched from the RewriteCond above. 114 | # %2 is the pathinfo, if any. 115 | RewriteCond %{DOCUMENT_ROOT}%1 !-f 116 | # AND the requested URI is not a file. 117 | # $1 is the site name, $2 is the file path. 118 | # These come from the RewriteRule below that this rule applies to. 119 | RewriteCond %{DOCUMENT_ROOT}/$1$2 !-f 120 | # AND the requested URI is not a directory. 121 | RewriteCond %{DOCUMENT_ROOT}/$1$2 !-d 122 | # Rewrite the request to go through the r.php (router) in the site folder. 123 | RewriteRule ^/([^/]+)(/.*)?$ /$1/r.php [L] 124 | 125 | 126 | -------------------------------------------------------------------------------- /setup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | SOURCE_HOME=$(pwd) 4 | 5 | # Make all shell script files executable. 6 | find $SOURCE_HOME -type f -iname "*.sh" -exec chmod +x {} \; 7 | 8 | if [ -e "$SOURCE_HOME/config.sh" ]; then 9 | source "$SOURCE_HOME/config.sh" 10 | else 11 | # Load default config. 12 | source "$SOURCE_HOME/config-dist.sh" 13 | fi 14 | 15 | # Disable automatic screen lock. 16 | gsettings set org.gnome.desktop.screensaver lock-enabled false 17 | 18 | # Add ondrej/php ppa so we can install other PHP versions. 19 | sudo add-apt-repository ppa:ondrej/php -y 20 | 21 | # Update and upgrade. 22 | sudo apt update && sudo apt upgrade -y 23 | 24 | # Install docker. 25 | sudo apt install -y \ 26 | apt-transport-https \ 27 | ca-certificates \ 28 | curl \ 29 | gnupg \ 30 | lsb-release \ 31 | software-properties-common \ 32 | uidmap \ 33 | dbus-user-session 34 | 35 | curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg 36 | 37 | echo \ 38 | "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ 39 | $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null 40 | 41 | sudo apt update 42 | 43 | sudo apt install -y docker-ce docker-ce-cli containerd.io 44 | 45 | # Install docker compose. 46 | sudo apt install docker-compose-plugin 47 | 48 | # Use docker as non-root user. 49 | dockerd-rootless-setuptool.sh install 50 | 51 | # Install ngrok. 52 | snap install ngrok 53 | 54 | # Create apps folder. 55 | mkdir $APPS_DIR 56 | 57 | # Copy scripts to apps folder. 58 | cp ./scripts/* $APPS_DIR 59 | chmod +x $APPS_DIR/switchphp.sh 60 | chmod +x $APPS_DIR/runngrok.sh 61 | 62 | # Install required programs. 63 | sudo apt install -y curl git default-jdk 64 | 65 | # Configure Git. 66 | git config --global core.filemode false 67 | git config --global core.autocrlf false 68 | # Set up Git email. 69 | if [ -n "$GIT_EMAIL" ]; then 70 | git config --global user.email "$GIT_EMAIL" 71 | fi 72 | # Set up Git name. 73 | if [ -n "$GIT_NAME" ]; then 74 | git config --global user.name "$GIT_NAME" 75 | fi 76 | 77 | PHP_INSTALL="" 78 | for phpver in "${PHP_VERSIONS[@]}" 79 | do 80 | # Install supported PHP versions. 81 | PHP_INSTALL="$PHP_INSTALL php$phpver" 82 | 83 | # Install required PHP extensions per version. 84 | for j in "${PHP_EXTS[@]}" 85 | do 86 | # PHP 8.0+ don't support XMLRPC anymore. Skip... 87 | if [ "$j" == "xmlrpc" ] && [ $(echo "$phpver >= 8.0"|bc -l) -eq 1 ] 88 | then 89 | continue 90 | fi 91 | PHP_INSTALL="$PHP_INSTALL php$phpver-$j" 92 | done 93 | # Install required PHP extensions. 94 | sudo apt install -y $PHP_INSTALL 95 | 96 | # Set max_input_vars to 5000. 97 | sudo sed -i_bak "/;max_input_vars.*/a max_input_vars = 5000" /etc/php/$phpver/apache2/php.ini 98 | sudo sed -i_bak "/;max_input_vars.*/a max_input_vars = 5000" /etc/php/$phpver/cli/php.ini 99 | 100 | # Reset for the next PHP version. 101 | PHP_INSTALL="" 102 | 103 | done 104 | 105 | # Set up PostgreSQL client and docker container. 106 | source "$SOURCE_HOME/setup/pgsql.sh" 107 | 108 | # Set up MariaDB client and docker container. 109 | source "$SOURCE_HOME/setup/mariadb.sh" 110 | 111 | # Set up MySQL client and docker container. 112 | source "$SOURCE_HOME/setup/mysqli.sh" 113 | 114 | # Install the ODBC Driver and SQL Command Line Utility for SQL Server. 115 | source "$SOURCE_HOME/setup/sqlsrv.sh" 116 | 117 | # Setup Oracle. 118 | if [ $INSTALL_ORACLE -eq 1 ]; then 119 | source "$SOURCE_HOME/setup/oci8.sh" 120 | fi 121 | 122 | # Switch to default PHP version. 123 | $APPS_DIR/switchphp.sh $DEFAULT_PHP_VERSION 124 | 125 | # Create www folder in home (for convenience). 126 | mkdir ~/www 127 | 128 | # Update the Apache configuration. 129 | sudo cp -R "${SOURCE_HOME}"/conf/apache2/* /etc/apache2/ 130 | sudo sed -i "s@/home/moodle@$HOME@g" /etc/apache2/sites-available/moodle.conf 131 | 132 | sudo a2enmod rewrite 133 | sudo a2dissite 000-default 134 | sudo a2ensite moodle 135 | 136 | # Add the www-data user to the current user's group to gain access to ~/www. 137 | sudo usermod -a -G `whoami` www-data 138 | 139 | # Restart apache. 140 | sudo service apache2 restart 141 | 142 | cd $APPS_DIR 143 | 144 | # Clone moodle-browser-config. 145 | git clone https://github.com/andrewnicols/moodle-browser-config.git $APPS_DIR/moodle-browser-config 146 | 147 | # Download latest geckodriver. 148 | curl -s https://api.github.com/repos/mozilla/geckodriver/releases/latest \ 149 | | grep browser_download_url \ 150 | | grep linux64 \ 151 | | cut -d '"' -f 4 \ 152 | | wget -qi - 153 | 154 | # Extract it. 155 | tar -xvzf "$(ls | grep 'geckodriver.*gz' | head -1)" 156 | 157 | # Delete the geckodriver package. 158 | rm geckodriver*.gz* 159 | 160 | # Link it to /usr/local/bin. 161 | sudo ln -s "$(pwd)/geckodriver" /usr/local/bin/geckodriver 162 | 163 | # MDK. 164 | 165 | # Install required packages. 166 | sudo apt install -y python3-pip libmysqlclient-dev libpq-dev python3-dev 167 | 168 | # Install MDK. 169 | UBUNTU_VER=$(lsb_release -r | awk '{print $2}') 170 | breaksystempackages="" 171 | # Check if the Ubuntu version is 23.04 or above. 172 | if [[ $(echo -e "$UBUNTU_VER\n23.04" | sort -V | head -n1) == "23.04" ]]; then 173 | # For Ubuntu 23.04 and above, add the --break-system-packages flag. 174 | breaksystempackages="--break-system-packages" 175 | fi 176 | sudo pip install moodle-sdk $breaksystempackages 177 | 178 | # Reload paths. 179 | source ~/.profile 180 | 181 | # Create MDK config.json. 182 | mkdir ~/.moodle-sdk 183 | touch ~/.moodle-sdk/config.json 184 | # GitHub-related MDK settings. 185 | if [ -n "$MDK_GITHUB_USER" ]; then 186 | mdk config set remotes.mine "git@github.com:$MDK_GITHUB_USER/moodle.git" 187 | mdk config set repositoryUrl "https://github.com/$MDK_GITHUB_USER/moodle.git" 188 | mdk config set diffUrlTemplate "https://github.com/$MDK_GITHUB_USER/moodle/compare/%headcommit%...%branch%" 189 | fi 190 | # Tracker-related MDK settings. 191 | if [ -n "$MDK_TRACKER_USER" ]; then 192 | mdk config set tracker.username $MDK_TRACKER_USER 193 | fi 194 | # dirs.www. 195 | if [ -n "$MDK_WWW_DIR" ]; then 196 | mdk config set dirs.www $MDK_WWW_DIR 197 | fi 198 | # dirs.storage. 199 | if [ -n "$MDK_MOODLES_DIR" ]; then 200 | mdk config set dirs.storage $MDK_MOODLES_DIR 201 | fi 202 | # Set PostgreSQL settings. 203 | mdk config set defaultEngine pgsql 204 | mdk config set db.pgsql.user postgres 205 | mdk config set db.pgsql.passwd $PGSQL_PASSWD 206 | # Set MariaDB settings. 207 | mdk config set db.mariadb.host 127.0.0.1 208 | mdk config set db.mariadb.passwd $MARIADB_PASSWD 209 | mdk config set db.mariadb.port $MARIADB_PORT 210 | # Set MySQLi settings. 211 | mdk config set db.mysqli.host 127.0.0.1 212 | mdk config set db.mysqli.passwd $MYSQLI_PASSWD 213 | mdk config set db.mysqli.port $MYSQLI_PORT 214 | mdk config set db.sqlsrv.passwd $SQLSRV_PASSWD 215 | 216 | mdk config set path 217 | mdk config set behat.useSeleniumGrid True 218 | 219 | # Create moodle instance and symlink folders. 220 | mkdir ~/moodles 221 | mkdir ~/www/mdk 222 | 223 | # Create index.php showing phpinfo(); 224 | printf ' ~/www/index.php 225 | 226 | # Download adminer and save it to ~/www/adminer.php. 227 | wget https://www.adminer.org/latest.php -O ~/www/adminer.php 228 | 229 | # Create a moodle.git main instance (stable_main). 230 | mdk create -i -r mindev users 231 | 232 | # Create a integration.git main instance (integration_main). 233 | mdk create -i -t -r mindev users 234 | 235 | cd ~/moodles/stable_main/moodle 236 | 237 | sed -i_bak "/^.*setup\.php.*/i require_once('${HOME}/apps/moodle-browser-config/init.php');" config.php 238 | 239 | # Initialise Behat. This will set up Behat and download Selenium server as well. 240 | mdk behat 241 | 242 | # Set alias for selenium. 243 | echo "alias sel='java -jar ${HOME}/.moodle-sdk/selenium-grid.jar standalone'" >> ~/.bashrc 244 | 245 | # Reload bashrc. 246 | source ~/.bashrc 247 | 248 | # Set up parallel run. 249 | # php admin/tool/behat/cli/init.php -j=2 -o 250 | 251 | # Install nvm. 252 | curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash 253 | export NVM_DIR="$HOME/.nvm" 254 | [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm 255 | [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion 256 | 257 | # Setup Chrome and Chromedriver. 258 | source "$SOURCE_HOME/setup/chromedriver.sh" 259 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------