Migrate to ZendFramework to Symfony

.env

@@ -0,0 +1,83 @@
+# In all environments, the following files are loaded if they exist,
+# the latter taking precedence over the former:
+#
+#  * .env                contains default values for the environment variables needed by the app
+#  * .env.local          uncommitted file with local overrides
+#  * .env.$APP_ENV       committed environment-specific defaults
+#  * .env.$APP_ENV.local uncommitted environment-specific overrides
+#
+# Real environment variables win over .env files.
+#
+# DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
+# https://symfony.com/doc/current/configuration/secrets.html
+#
+# Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
+# https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration
+
+# Saml Authentication
+SAML_IDP_ENTITYID="https://idp.example.edu/abc123"
+SAML_IDP_SINGLESIGNONSERVICE="https://idp.example.edu/abc123/saml2"
+SAML_IDP_SINGLELOGOUTSERVICE="https://idp.example.edu/abc123/saml2"
+SAML_IDP_X509CERT="MIIC...."
+
+# Catalog
+CATALOG_BANNER_WEB_URL=""
+
+# Schedules
+SCHEDULES_EMAIL_ENABLED=false
+SCHEDULES_EMAIL_SEND_MAIL_AS_USER=false
+[email protected]
+SCHEDULES_IMAGE_FONT_FILE=/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf
+
+# Sync
+SYNC_ERROR_MAIL_TO="[email protected]"
+SYNC_ERROR_MAIL_FROM="[email protected]"
+# A JSON encoded array of Block Codes that should be exposed to users.
+SYNC_ALLOWED_BLOCK_CODES='["CC"]'
+# Sync destination (this application's database)
+SYNC_DESTINATION_DSN="mysql:host=database;port=3306;dbname=symfony;charset=utf8mb4"
+SYNC_DESTINATION_USERNAME=symfony
+SYNC_DESTINATION_PASSWORD=symfony
+# The sync strategy to use. One of the following:
+#   'sync.strategy.oci'
+#   'sync.strategy.oci_with_cache'
+#   'sync.strategy.pdo_msyql'
+# Depending on which strategy is chosen, different additional parameters (below)
+# need to be configured.
+SYNC_STRATEGY='sync.strategy.oci'
+# Sync source (using an Oracle connection) for Oci & OciWithCache sync strategies.
+SYNC_SOURCE_OCI_TNS="(DESCRIPTION = (ADDRESS_LIST =(ADDRESS = (PROTOCOL = TCP)(HOST = reporting-database-prod.ec.example.edu)(PORT = 8000))) (CONNECT_DATA = (SID = SNAPSHOT)))"
+SYNC_SOURCE_OCI_USERNAME=""
+SYNC_SOURCE_OCI_PASSWORD=""
+# Temporary Mysql/Mariadb database if using (OciWithCache) sync strategy.
+SYNC_TEMP_DSN="mysql:host=database;port=3306;dbname=catalog_temp;charset=utf8mb4"
+SYNC_TEMP_USERNAME=symfony
+SYNC_TEMP_PASSWORD=symfony
+# The OciWithCache sync strategy copies into the live database with
+# mysqldump & mysql commands. If these are at different paths/names, then
+#customize them.
+SYNC_MYSQL_COMMAND=mysql
+SYNC_MYSQLDUMP_COMMAND=mysqldump
+# The PdoMysql sync strategy reads from a Mysql/Mariadb connection.
+SYNC_SOURCE_PDOMYSQL_DSN="mysql:host=database;port=3306;dbname=catalog_temp;charset=utf8mb4"
+SYNC_SOURCE_PDOMYSQL_USERNAME=symfony
+SYNC_SOURCE_PDOMYSQL_PASSWORD=symfony
+
+###> symfony/framework-bundle ###
+APP_ENV=dev
+APP_SECRET=af0c5e8cb62edd2dd690260da18618a2
+###< symfony/framework-bundle ###
+
+###> doctrine/doctrine-bundle ###
+# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
+# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
+#
+# DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
+# DATABASE_URL="mysql://app:[email protected]:3306/app?serverVersion=8.0.32&charset=utf8mb4"
+DATABASE_URL="mysql://symfony:symfony@database:3306/symfony?serverVersion=10.3.27-MariaDB&charset=utf8mb4"
+# DATABASE_URL="postgresql://app:[email protected]:5432/app?serverVersion=16&charset=utf8"
+###< doctrine/doctrine-bundle ###
+
+###> symfony/mailer ###
+MAILER_DSN=null://null
+###< symfony/mailer ###

.env.test

@@ -0,0 +1,7 @@
+# define your env variables for the test env here
+KERNEL_CLASS='App\Kernel'
+APP_SECRET='$ecretf0rt3st'
+SYMFONY_DEPRECATIONS_HELPER=999999
+PANTHER_APP_ENV=panther
+PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots
+SCHEDULES_EMAIL_ENABLED=true

.gitignore

@@ -8,3 +8,32 @@ progress.txt
 vendor/
 .phpunit.result.cache
 .php-cs-fixer.cache
+
+###> symfony/framework-bundle ###
+/.env.local
+/.env.local.php
+/.env.*.local
+/config/secrets/prod/prod.decrypt.private.php
+/public/bundles/
+/var/
+/vendor/
+###< symfony/framework-bundle ###
+
+###> symfony/phpunit-bridge ###
+.phpunit.result.cache
+/phpunit.xml
+###< symfony/phpunit-bridge ###
+
+###> phpunit/phpunit ###
+/phpunit.xml
+.phpunit.result.cache
+###< phpunit/phpunit ###
+
+###> symfony/asset-mapper ###
+/public/assets/
+/assets/vendor/
+###< symfony/asset-mapper ###
+###> friendsofphp/php-cs-fixer ###
+/.php-cs-fixer.php
+/.php-cs-fixer.cache
+###< friendsofphp/php-cs-fixer ###

.gitmodules

@@ -7,10 +7,3 @@
 [submodule "library/lazy_sessions"]
 	path = library/lazy_sessions
 	url = https://github.com/middlebury/lazy_sessions.git
-[submodule "docroot/javascript/jquery-week-calendar"]
-	path = docroot/javascript/jquery-week-calendar
-	url = https://github.com/themouette/jquery-week-calendar.git
-[submodule "library/jsdifflib"]
-	path = library/jsdifflib
-	url = https://github.com/cemerick/jsdifflib.git
-	branch = master

.lando.yml

@@ -0,0 +1,74 @@
+name: coursecatalog
+recipe: symfony
+config:
+  webroot: public
+  php: 8.1
+  database: mariadb:10.11
+services:
+  appserver:
+    build_as_root:
+      - apt update
+      - mkdir /opt/oracle
+      - rm -Rf /opt/oracle/*
+      # Fetch binaries directly from Oracle:
+      # https://www.oracle.com/database/technologies/instant-client/downloads.html
+      - curl https://download.oracle.com/otn_software/linux/instantclient/instantclient-basic-linux-arm64.zip > /opt/oracle/instantclient-basic.zip
+      - curl https://download.oracle.com/otn_software/linux/instantclient/instantclient-sdk-linux-arm64.zip > /opt/oracle/instantclient-sdk.zip
+      # Unzip
+      - unzip -o /opt/oracle/instantclient-basic.zip -d /opt/oracle
+      - unzip -o /opt/oracle/instantclient-sdk.zip -d /opt/oracle
+      # Add sqlplus command line Oracle client for debugging.
+      - curl https://download.oracle.com/otn_software/linux/instantclient/instantclient-sqlplus-linux-arm64.zip > /opt/oracle/instantclient-sqlplus.zip
+      - unzip -o /opt/oracle/instantclient-sqlplus.zip -d /opt/oracle
+      # Delete all of our downloads.
+      - rm /opt/oracle/*.zip
+      # Make a symlink to the versioned directory.
+      - ln -s /opt/oracle/instantclient_* /opt/oracle/instantclient
+      # Make OS aware of newly installed libraries
+      - echo /opt/oracle/instantclient > /etc/ld.so.conf.d/oracle-instantclient.conf
+      - ldconfig -v
+      # Set the interpreter for the Oracle command-line tools.
+      # See: https://askubuntu.com/questions/1397724/no-such-file-or-directory-when-running-sqlplus-command
+      # This is not needed for the Oci8 PHP extension itself, but is needed to
+      # get sqlplus command-line Oracle client working for debugging.
+      - apt -y install patchelf
+      - patchelf --set-interpreter /lib/ld-linux-aarch64.so.1 /opt/oracle/instantclient/adrci
+      - patchelf --set-interpreter /lib/ld-linux-aarch64.so.1 /opt/oracle/instantclient/genezi
+      - patchelf --set-interpreter /lib/ld-linux-aarch64.so.1 /opt/oracle/instantclient/sqlplus
+      - patchelf --set-interpreter /lib/ld-linux-aarch64.so.1 /opt/oracle/instantclient/uidrvci
+      # Install libaio1 -- when missing was preventing the extension from loading.
+      - apt install libaio1
+      # Install and enable OCI8
+      - echo "instantclient,/opt/oracle/instantclient" | pecl install oci8-3.2.1
+      - docker-php-ext-enable oci8
+    overrides:
+      environment:
+        MAILER_DSN: smtp://mailpit:1025
+  phpmyadmin:
+    type: phpmyadmin
+    hosts:
+      - database
+  mailpit:
+    scanner: false
+    api: 3
+    type: lando
+    services:
+      image: axllent/mailpit
+      volumes:
+        - mailpit:/data
+      ports:
+        - 8025 # Web UI.
+        - 1025 # SMTP.
+      environment:
+        MP_MAX_MESSAGES: 5000
+        MP_DATA_FILE: /data/mailpit.db
+        MP_SMTP_AUTH_ACCEPT_ANY: 1
+        MP_SMTP_AUTH_ALLOW_INSECURE: 1
+      command: '/mailpit'
+    volumes:
+      mailpit:
+proxy:
+    mailpit:
+        - mail.coursecatalog.lndo.site:8025
+    phpmyadmin:
+        - phpmyadmin.coursecatalog.lndo.site

.php-cs-fixer.dist.php

@@ -5,6 +5,8 @@
     ->notPath([
         'vendor',
         '#^library#',
+        '#^application/library/harmoni/Primitives/Collections-Text/SafeHTML/classes/HTMLSax3#',
+        '#^var#',
     ])
 ;
 

README.md

@@ -15,10 +15,10 @@ Examples
 
 Examples of the the Course-Catalog in action at <a href="http://www.middlebury.edu">Middlebury College</a>:
 
-* [Main Search UI](https://catalog.middlebury.edu/catalogs/view/catalog/catalog%2FMCUG) (catalog app)
-* [Section Details Page](https://catalog.middlebury.edu/offerings/view/catalog/catalog%2FMCUG/offering/section%2F201090%2F91241) (catalog app)
-* [Department "courses" RSS feed](https://catalog.middlebury.edu/courses/topicxml/catalog/catalog%2FMCUG/topic/topic%2Fdepartment%2FBIOL) (catalog app)
-* [Departments listing to feed to the Drupal content type form](https://catalog.middlebury.edu/topics/listdepartmentstxt/catalog/catalog%2FMCUG/) (catalog app)
+* [Main Search UI](https://catalog.middlebury.edu/catalogs/view/catalog/catalog.MCUG) (catalog app)
+* [Section Details Page](https://catalog.middlebury.edu/offerings/view/catalog/catalog.MCUG/offering/section.201090.91241) (catalog app)
+* [Department "courses" RSS feed](https://catalog.middlebury.edu/courses/topicxml/catalog/catalog.MCUG/topic/topic.department.BIOL) (catalog app)
+* [Departments listing to feed to the Drupal content type form](https://catalog.middlebury.edu/topics/listdepartmentstxt/catalog/catalog.MCUG/) (catalog app)
 * [Department Course Listing](http://www.middlebury.edu/academics/bio/courses) (Drupal "courses" content-type displaying a feed from the catalog app)
 * [Department Section Listing](http://www.middlebury.edu/academics/bio/courses/offerings) (Drupal "courses" content-type displaying a feed from the catalog app)
 * [Faculty Profile](http://www.middlebury.edu/academics/bio/faculty/node/48111) (Drupal "profile" content-type displaying a feed from the catalog app)</li>
@@ -39,16 +39,40 @@ These instructions assume that you have a POSIX machine running Apache with PHP
    cd coursecatalog
    git-submodule update --init --recursive
    ```
-3. Make a symbolic link to the `coursecatalog/docroot/` directory in a web-accessible directory or add a virtualhost rooted in the `coursecatalog/docroot/` directory.
-4. Create a MySQL database for the catalogs data and a cache of Banner data.
-5. Make copies of the example config files at `configuration.plist`, `frontend_config.ini`, and `update_config.ini` and edit values to match your environment.
-6. Create the database tables defined in `application/library/banner/course/sql/table_creation.sql`
-7. Run the script at `bin/update-from-banner.php` to dump Banner data into the the MySQL database:
+3. Install additional dependencies with Composer:
+   ```
+   composer install
+   ```
+4. Make a symbolic link to the `coursecatalog/docroot/` directory in a web-accessible directory or add a virtualhost rooted in the `coursecatalog/docroot/` directory.
+5. Create a MySQL database for the catalogs data and a cache of Banner data.
+6. Make copies of the example config files at `configuration.plist`, `frontend_config.ini`, and `update_config.ini` and edit values to match your environment.
+7. Create the database tables defined in `application/library/banner/course/sql/table_creation.sql`
+8. Run the script at `bin/update-from-banner.php` to dump Banner data into the the MySQL database:
    ```
    php bin/update-from-banner.php
    php bin/build_indices.php
    ```
 
+## Development environment setup
+
+### Lando
+Install Docker and Lando to provide a local containerized environment
+
+In the code directory, start the local containers with `lando start`
+
+### Copying the production database
+Dump the production database to a non version-controlled file path like `var/catalog_prod.sql`.
+
+Strip out any `DEFINER` statements that will break the import:
+```
+sed -i '' 's/DEFINER=[^*]*\*/\*/g' var/catalog_prod.sql
+```
+
+Import the database into the local container:
+```
+lando db-import var/catalog_prod.sql
+```
+
 Unit Tests
 ----------