├── .gitignore
├── demo
    ├── php
    │   ├── config.header.inc.php
    │   ├── robots.txt
    │   ├── config.inc.php
    │   ├── config-http.inc.php
    │   ├── config-config.inc.php
    │   ├── config-cookie.inc.php
    │   ├── config-config-mysql.inc.php
    │   ├── config.footer.inc.php
    │   ├── versions.ini
    │   ├── config-config-nopmadb.inc.php
    │   └── config-common.inc.php
    ├── sql
    │   ├── world.sql
    │   ├── menagerie-db
    │   │   ├── ins_puff_rec.sql
    │   │   ├── load_pet_tbl.sql
    │   │   ├── cr_event_tbl.sql
    │   │   ├── cr_pet_tbl.sql
    │   │   ├── pet.txt
    │   │   ├── event.txt
    │   │   └── README.txt
    │   ├── sakila-db
    │   │   ├── sakila-data.sql
    │   │   └── sakila-schema.sql
    │   ├── README.rst
    │   ├── privileges.sql
    │   ├── run-mysql
    │   └── create_tables.sql
    ├── maintenance
    │   ├── demoserver-cleanup
    │   ├── lvm-split-mirror
    │   ├── make-snapshot
    │   ├── restore-snapshot
    │   ├── lvm-make-mirror
    │   ├── reset-demo
    │   ├── demoserver-tester
    │   ├── demoserver-locklib
    │   └── mysql-tester
    └── bin
    │   ├── pma-revision-info
    │   └── pma-demo-update
├── infrastructure
    ├── .gitignore
    └── sentry
    │   ├── dockerl
    │   ├── .env.dist
    │   ├── README.md
    │   └── docker-compose.yml
├── develdocs
    ├── .gitignore
    ├── composer.json
    ├── output
    │   ├── favicon.ico
    │   ├── .gitignore
    │   └── index.html
    ├── build.sh
    └── doctum.php
├── hooks
    ├── .gitignore
    ├── index.html
    ├── docs.php
    ├── website.php
    ├── composer.json
    ├── config-example.php
    ├── create_release.php
    ├── README.rst
    ├── create.php
    ├── push.php
    ├── commits.php
    └── lib
    │   └── github.php
├── website
    ├── sync-files-cdn
    ├── README
    ├── update-docs
    ├── generate-missing-checksums
    ├── update-website
    ├── daily-snapshots
    └── daily-composer
├── backup
    ├── README.rst
    ├── backup-init
    └── backup
├── README.rst
├── monitoring
    ├── README.rst
    ├── check_phpmyadmin_composer.sh
    ├── check_phpmyadmin_daily_snapshots.py
    └── check_phpmyadmin_docker.sh
├── documentation-po-update
├── list-top-authors
├── cleanup-untranslated-po
├── phpmyadmin-reports
└── phpmyadmin-report.php


/.gitignore:
--------------------------------------------------------------------------------
1 | *.swp
2 | 


--------------------------------------------------------------------------------
/demo/php/config.header.inc.php:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/infrastructure/.gitignore:
--------------------------------------------------------------------------------
1 | .env*
2 | !.env.dist
3 | 


--------------------------------------------------------------------------------
/develdocs/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | /composer.lock
3 | /tmp
4 | 


--------------------------------------------------------------------------------
/hooks/.gitignore:
--------------------------------------------------------------------------------
1 | config.php
2 | vendor
3 | composer.lock
4 | 


--------------------------------------------------------------------------------
/hooks/index.html:
--------------------------------------------------------------------------------
1 | <html>
2 | <body>
3 | <p>phpMyAdmin hooks server</p>
4 | </body>
5 | 


--------------------------------------------------------------------------------
/demo/sql/world.sql:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/phpmyadmin/scripts/master/demo/sql/world.sql


--------------------------------------------------------------------------------
/infrastructure/sentry/dockerl:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | 
3 | docker-compose -p phpmyadmin-sentry $@
4 | 


--------------------------------------------------------------------------------
/develdocs/composer.json:
--------------------------------------------------------------------------------
1 | {
2 |     "require": {
3 |         "code-lts/doctum": "^5.5"
4 |     }
5 | }
6 | 


--------------------------------------------------------------------------------
/develdocs/output/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/phpmyadmin/scripts/master/develdocs/output/favicon.ico


--------------------------------------------------------------------------------
/develdocs/output/.gitignore:
--------------------------------------------------------------------------------
1 | /phpmyadmin/
2 | /motranslator/
3 | /shapefile/
4 | /sql-parser/
5 | /simple-math/
6 | 


--------------------------------------------------------------------------------
/demo/sql/menagerie-db/ins_puff_rec.sql:
--------------------------------------------------------------------------------
1 | INSERT INTO pet VALUES ('Puffball','Diane','hamster','f','1999-03-30',NULL);
2 | 


--------------------------------------------------------------------------------
/demo/sql/sakila-db/sakila-data.sql:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/phpmyadmin/scripts/master/demo/sql/sakila-db/sakila-data.sql


--------------------------------------------------------------------------------
/demo/php/robots.txt:
--------------------------------------------------------------------------------
1 | User-agent: *
2 | Disallow: /master
3 | Disallow: /master*
4 | Disallow: /MAINT_*
5 | Disallow: /QA_*
6 | Disallow: /STABLE
7 | 


--------------------------------------------------------------------------------
/website/sync-files-cdn:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | 
3 | # trigger website scan
4 | cd /home/builder/website/
5 | ./manage.py import_files
6 | ./manage.py import_themes
7 | 


--------------------------------------------------------------------------------
/backup/README.rst:
--------------------------------------------------------------------------------
1 | Server backup scripts
2 | =====================
3 | 
4 | This directory contains scripts using borgbackup to perform server backups.
5 | 
6 | 


--------------------------------------------------------------------------------
/backup/backup-init:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | export BORG_PASSPHRASE=`cat /etc/borg-key`
3 | borg init --encryption=repokey-blake2 ssh://borgbackup/./backups/`hostname`
4 | 


--------------------------------------------------------------------------------
/infrastructure/sentry/.env.dist:
--------------------------------------------------------------------------------
1 | SENTRY_SECRET_KEY=
2 | POSTGRES_PASSWORD=
3 | 
4 | POSTGRES_DATA_VOLUME=
5 | SENTRY_DATA_VOLUME=
6 | 
7 | SENTRY_SERVER_EMAIL=
8 | 


--------------------------------------------------------------------------------
/demo/sql/menagerie-db/load_pet_tbl.sql:
--------------------------------------------------------------------------------
1 | # empty the table
2 | DELETE FROM pet;
3 | 
4 | # load new records into it
5 | LOAD DATA LOCAL INFILE 'pet.txt' INTO TABLE pet;
6 | 


--------------------------------------------------------------------------------
/demo/php/config.inc.php:
--------------------------------------------------------------------------------
1 | <?php
2 | require('/home/demo/scripts/demo/php/config-common.inc.php');
3 | $cfg['Servers'][$i]['extension'] = 'mysqli';
4 | $cfg['Servers'][$i]['auth_type'] = 'cookie';
5 | ?>
6 | 


--------------------------------------------------------------------------------
/demo/maintenance/demoserver-cleanup:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | # Script to reset demo server to clean state
 3 | 
 4 | . ./demoserver-locklib
 5 | 
 6 | exlock || exit 1
 7 | 
 8 | ./reset-demo mariadb 99<&-
 9 | ./reset-demo mysql 99<&-
10 | 


--------------------------------------------------------------------------------
/website/README:
--------------------------------------------------------------------------------
1 | Scripts for phpMyAdmin website
2 | ==============================
3 | 
4 | Here are various scripts which are used to build phpMyAdmin website.
5 | 
6 |  -- Michal Čihař <michal@cihar.com>  Wed, 10 Jun 2009 15:29:15 +0200
7 | 


--------------------------------------------------------------------------------
/demo/maintenance/lvm-split-mirror:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Script to split a LVM mirror
 3 | 
 4 | if [ -z "$1" ] ; then
 5 | 	echo "Usage: lvm-split-mirror NAME"
 6 | 	exit 1
 7 | fi
 8 | 
 9 | lvconvert --splitmirrors 1 --name demo-$1 vg0/demo-$1-template
10 | 


--------------------------------------------------------------------------------
/hooks/docs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Readthedocs webhook to trigger push content to CDN
 4 |  */
 5 | 
 6 | error_reporting(E_ALL);
 7 | 
 8 | define('PMAHOOKS', true);
 9 | 
10 | require_once __DIR__ . '/lib/github.php';
11 | 
12 | trigger_docs_render();
13 | 


--------------------------------------------------------------------------------
/demo/maintenance/make-snapshot:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Script to make a LVM snapshot of a demo server
 3 | 
 4 | if [ -z "$1" ] ; then
 5 | 	echo "Usage: make-snapshot NAME"
 6 | 	exit 1
 7 | fi
 8 | 
 9 | /sbin/lvcreate -s -n demo-$1-snapshot -L 4G /dev/mapper/vg0-demo--$1
10 | 


--------------------------------------------------------------------------------
/demo/maintenance/restore-snapshot:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Script to merge LVM snapshot into original volume
 3 | 
 4 | if [ -z "$1" ] ; then
 5 | 	echo "Usage: restore-snapshot NAME"
 6 | 	exit 1
 7 | fi
 8 | 
 9 | /sbin/lvconvert --merge /dev/mapper/vg0-demo--$1--snapshot
10 | 


--------------------------------------------------------------------------------
/demo/maintenance/lvm-make-mirror:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Script to make a LVM mirror
 3 | 
 4 | if [ -z "$1" ] ; then
 5 | 	echo "Usage: lvm-make-mirror NAME"
 6 | 	exit 1
 7 | fi
 8 | 
 9 | lvconvert --mirrors 1 --type mirror --mirrorlog core --alloc anywhere  vg0/demo-$1-template
10 | 


--------------------------------------------------------------------------------
/demo/sql/menagerie-db/cr_event_tbl.sql:
--------------------------------------------------------------------------------
 1 | # drop the event table if it exists, then recreate it
 2 | 
 3 | DROP TABLE IF EXISTS event;
 4 | 
 5 | CREATE TABLE event
 6 | (
 7 |   name   VARCHAR(20),
 8 |   date   DATE,
 9 |   type   VARCHAR(15),
10 |   remark VARCHAR(255)
11 | );
12 | 


--------------------------------------------------------------------------------
/hooks/website.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * GitHub webhook to trigger website rebuild
 4 |  */
 5 | 
 6 | error_reporting(E_ALL);
 7 | 
 8 | define('PMAHOOKS', true);
 9 | 
10 | require_once __DIR__ . '/lib/github.php';
11 | 
12 | github_verify_post();
13 | 
14 | trigger_website_render();
15 | 


--------------------------------------------------------------------------------
/demo/php/config-http.inc.php:
--------------------------------------------------------------------------------
1 | <?php
2 | require('/home/demo/scripts/demo/php/config-common.inc.php');
3 | $cfg['Servers'][1]['extension'] = 'mysqli';
4 | $cfg['Servers'][1]['auth_type'] = 'http';
5 | $cfg['Servers'][2]['extension'] = 'mysqli';
6 | $cfg['Servers'][2]['auth_type'] = 'http';
7 | ?>
8 | 


--------------------------------------------------------------------------------
/demo/php/config-config.inc.php:
--------------------------------------------------------------------------------
1 | <?php
2 | require('/home/demo/scripts/demo/php/config-common.inc.php');
3 | $cfg['Servers'][1]['extension'] = 'mysqli';
4 | $cfg['Servers'][1]['auth_type'] = 'config';
5 | $cfg['Servers'][2]['extension'] = 'mysqli';
6 | $cfg['Servers'][2]['auth_type'] = 'config';
7 | ?>
8 | 


--------------------------------------------------------------------------------
/demo/php/config-cookie.inc.php:
--------------------------------------------------------------------------------
1 | <?php
2 | require('/home/demo/scripts/demo/php/config-common.inc.php');
3 | $cfg['Servers'][1]['extension'] = 'mysqli';
4 | $cfg['Servers'][1]['auth_type'] = 'cookie';
5 | $cfg['Servers'][2]['extension'] = 'mysqli';
6 | $cfg['Servers'][2]['auth_type'] = 'cookie';
7 | ?>
8 | 


--------------------------------------------------------------------------------
/demo/sql/README.rst:
--------------------------------------------------------------------------------
 1 | SQL data for phpMyAdmin demo server
 2 | ===================================
 3 | 
 4 | This collects various data used on phpMyAdmin demo server.
 5 | 
 6 | Installation:
 7 | 
 8 | - ``run-mysql`` creates all databases
 9 | - ``privileges.sql`` creates needed users and grants
10 | 


--------------------------------------------------------------------------------
/demo/maintenance/reset-demo:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Script to reset demo virtual machine to snapshot
 3 | 
 4 | if [ -z "$1" ] ; then
 5 | 	echo "Usage: reset-demo NAME"
 6 | 	exit 1
 7 | fi
 8 | 
 9 | virsh destroy demo-$1
10 | sleep 5
11 | ./restore-snapshot $1
12 | ./make-snapshot $1
13 | virsh start demo-$1
14 | 


--------------------------------------------------------------------------------
/demo/php/config-config-mysql.inc.php:
--------------------------------------------------------------------------------
1 | <?php
2 | require('/home/demo/scripts/demo/php/config-common.inc.php');
3 | $cfg['Servers'][1]['extension'] = 'mysql';
4 | $cfg['Servers'][1]['auth_type'] = 'config';
5 | $cfg['Servers'][2]['extension'] = 'mysql';
6 | $cfg['Servers'][2]['auth_type'] = 'config';
7 | ?>
8 | 


--------------------------------------------------------------------------------
/demo/sql/menagerie-db/cr_pet_tbl.sql:
--------------------------------------------------------------------------------
 1 | # drop the pet table if it exists, then recreate it
 2 | 
 3 | DROP TABLE IF EXISTS pet;
 4 | 
 5 | CREATE TABLE pet
 6 | (
 7 |   name    VARCHAR(20),
 8 |   owner   VARCHAR(20),
 9 |   species VARCHAR(20),
10 |   sex     CHAR(1),
11 |   birth   DATE,
12 |   death   DATE
13 | );
14 | 


--------------------------------------------------------------------------------
/demo/sql/menagerie-db/pet.txt:
--------------------------------------------------------------------------------
1 | Fluffy	Harold	cat	f	1993-02-04	\N
2 | Claws	Gwen	cat	m	1994-03-17	\N
3 | Buffy	Harold	dog	f	1989-05-13	\N
4 | Fang	Benny	dog	m	1990-08-27	\N
5 | Bowser	Diane	dog	m	1979-08-31	1995-07-29
6 | Chirpy	Gwen	bird	f	1998-09-11	\N
7 | Whistler	Gwen	bird	\N	1997-12-09	\N
8 | Slim	Benny	snake	m	1996-04-29	\N
9 | 


--------------------------------------------------------------------------------
/hooks/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "phpmyadmin/scripts",
 3 |     "type": "project",
 4 |     "require": {
 5 |         "phpmailer/phpmailer": "^6.7.1"
 6 |     },
 7 |     "homepage": "https://github.com/phpmyadmin/scripts",
 8 |     "readme": "https://github.com/phpmyadmin/scripts#readme",
 9 |     "description": "Various scripts used by phpMyAdmin"
10 | }
11 | 


--------------------------------------------------------------------------------
/demo/maintenance/demoserver-tester:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | # Script to check demo server status and reset it to sane when wrong
 3 | 
 4 | . ./demoserver-locklib
 5 | 
 6 | exlock_now || exit 1
 7 | 
 8 | if ! ./mysql-tester mysql 192.168.30.23 ; then
 9 |     ./reset-demo mysql 99<&-
10 | fi
11 | 
12 | if ! ./mysql-tester mariadb 192.168.30.22 ; then
13 |     ./reset-demo mariadb 99<&-
14 | fi
15 | 


--------------------------------------------------------------------------------
/website/update-docs:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | # Script executed from cron on commit to website repo
 4 | 
 5 | set -e
 6 | 
 7 | # Check for trigger created by hooks/docs.php
 8 | # (this is due to privilege separation)
 9 | if [ ! -f /home/builder/.pma/build-docs -a "x$1" != "x--force" ] ; then 
10 |     exit 0
11 | fi
12 | 
13 | # Remove trigger
14 | rm -f /home/builder/.pma/build-docs
15 | 
16 | # Update website repo
17 | cd /home/builder/website/
18 | 


--------------------------------------------------------------------------------
/demo/php/config.footer.inc.php:
--------------------------------------------------------------------------------
 1 | <script>
 2 |   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
 3 |   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
 4 |   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
 5 |   })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 6 | 
 7 |   ga('create', 'UA-2718724-5', 'auto');
 8 |   ga('send', 'pageview');
 9 | 
10 | </script>
11 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
 1 | Various scripts used by phpMyAdmin
 2 | ==================================
 3 | 
 4 | Usually you don't need anything in this repository, it just contains various
 5 | scripts which help in development of phpMyAdmin or produce useful stats.
 6 | 
 7 | * `backup` - scripts for backing up servers using borg
 8 | * `demo` - demo server maintenance scripts
 9 | * `develdocs` - developer documentation builds
10 | * `hooks` - GitHub webhooks
11 | * `website` - website maintenance scripts
12 | 


--------------------------------------------------------------------------------
/demo/sql/menagerie-db/event.txt:
--------------------------------------------------------------------------------
 1 | Fluffy	1995-05-15	litter	4 kittens, 3 female, 1 male
 2 | Buffy	1993-06-23	litter	5 puppies, 2 female, 3 male
 3 | Buffy	1994-06-19	litter	3 puppies, 3 female
 4 | Chirpy	1999-03-21	vet	needed beak straightened
 5 | Slim	1997-08-03	vet	broken rib
 6 | Bowser	1991-10-12	kennel
 7 | Fang	1991-10-12	kennel
 8 | Fang	1998-08-28	birthday	Gave him a new chew toy
 9 | Claws	1998-03-17	birthday	Gave him a new flea collar
10 | Whistler	1998-12-09	birthday	First birthday
11 | 


--------------------------------------------------------------------------------
/website/generate-missing-checksums:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # Generates missing checksums for download files
 4 | 
 5 | cd /mnt/storage/files
 6 | 
 7 | find . -name '*.bz2' -o -name '*.gz' -o -name '*.7z' -o -name '*.xz' -o -name '*.zip' | while read filename ; do
 8 |         for hash in sha1 sha256 ; do
 9 |                 if [ ! -f $filename.$hash ] ; then
10 |                         pushd `dirname $filename`
11 |                         base=`basename $filename`
12 |                         ${hash}sum $base > $base.$hash
13 |                         popd
14 |                 fi
15 |         done
16 | done
17 | 


--------------------------------------------------------------------------------
/monitoring/README.rst:
--------------------------------------------------------------------------------
 1 | Scripts for monitoring downloads
 2 | ================================
 3 | 
 4 | These scripts are for monitoring daily snapshot downloads as well as the Composer and Docker packages.
 5 | 
 6 | Of particular note, the daily snapshot tool requires some extra Python package, BeautifulSoup4.
 7 | 
 8 | On Debian, this is probably available as ``python3-bs4``.
 9 | 
10 | Aside from Debian, I suggest creating a venv for this. I did it with ``python3 -m venv daily_snapshot_venv`` then source that with
11 | ``source daily_snapshot_venv/bin/activate``.
12 | Install 'beautifulsoup4' to the venv.
13 | 
14 | 


--------------------------------------------------------------------------------
/demo/php/versions.ini:
--------------------------------------------------------------------------------
 1 | #
 2 | # The demo server configuration
 3 | #
 4 | # It will get updated within one hour from committing changes.
 5 | 
 6 | [demo]
 7 | # Format: <variant-name>:<branch>
 8 | variants[] = master:master
 9 | variants[] = master-config:master
10 | variants[] = master-http:master
11 | variants[] = master-config-nopmadb:master
12 | variants[] = STABLE:STABLE
13 | variants[] = QA_5_2:QA_5_2
14 | 
15 | # Version of future release from master branch, used by the website
16 | master-release = 6.0.0
17 | 
18 | # List of themes to link
19 | # mhn is 4.{8,9} only
20 | themes[] = mhn
21 | themes[] = fallen
22 | themes[] = darkmod-neo
23 | themes[] = darkwolf
24 | themes[] = boodark
25 | themes[] = eyed
26 | themes[] = blueberry
27 | 


--------------------------------------------------------------------------------
/website/update-website:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | # Script executed from cron on commit to website repo
 4 | 
 5 | set -e
 6 | 
 7 | # Check for trigger created by hooks/website.php
 8 | # (this is due to privilege separation)
 9 | if [ ! -f /home/builder/.pma/build-website -a "x$1" != "x--force" ] ; then 
10 |     exit 0
11 | fi
12 | 
13 | # Remove trigger
14 | rm -f /home/builder/.pma/build-website
15 | 
16 | # Update website repo
17 | cd /home/builder/website/
18 | git pull --rebase -q
19 | sudo /root/bin/restart-uwsgi-website
20 | 
21 | # Static files
22 | ./manage.py collectstatic --noinput --link -v 0
23 | ./manage.py compress -v 0 > /dev/null
24 | 
25 | # Migrate database
26 | ./manage.py migrate -v 0
27 | 
28 | # Purge all pages in CDN
29 | ./manage.py purge_cdn
30 | 
31 | 


--------------------------------------------------------------------------------
/monitoring/check_phpmyadmin_composer.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | supported_versions=$(curl -fsSL 'https://www.phpmyadmin.net/home_page/version.json'|jq -r '.releases|.[]|.version')
 4 | working_dir="$HOME/tmp/composer-test"
 5 | 
 6 | mkdir -p "$working_dir"
 7 | cd "$working_dir" || exit 1
 8 | 
 9 | test_version() {
10 | 	ver=$1
11 | 	echo "Processing $ver"
12 | 
13 |   composer create-project -q phpmyadmin/phpmyadmin "$ver" "$ver" > /dev/null
14 |   grep "$ver" "$ver/ChangeLog" > /dev/null || echo "Failed to find version $ver in $ver/ChangeLog" 
15 |   rm -rf "$ver"
16 | }
17 | 
18 | while read -r full_version
19 | # https://unix.stackexchange.com/questions/9784/how-can-i-read-line-by-line-from-a-variable-in-bash
20 | do
21 |   test_version "$full_version"
22 | done < <(printf '%s\n' "$supported_versions")


--------------------------------------------------------------------------------
/backup/backup:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | export BORG_PASSPHRASE=`cat /etc/borg-key`
 3 | 
 4 | # Create new backup
 5 | borg create ssh://borgbackup/./backups/`hostname`::'{now:%Y-%m-%d_%H:%M}' `cat /etc/borg-dirs`
 6 | 
 7 | # Prune old backups, we keep last year of backups in descending frequency
 8 | # - daily backups for 14 days
 9 | # - weekly backups for 8 weeks
10 | # - monthly backups for 12 months
11 | borg prune --keep-weekly 8 --keep-monthly 12 --keep-daily 14 ssh://borgbackup/./backups/`hostname`
12 | 
13 | # Compact repository to free up disk space that is still in use after being de-allocated by prune.
14 | # This is needed since Borg 1.2.0
15 | # Since it doesn't exist prior to 1.2.0, we test so as to avoid failing
16 | if borg help compact  >/dev/null 2>&1; then
17 |   borg compact ssh://borgbackup/./backups/`hostname`
18 | fi
19 | 


--------------------------------------------------------------------------------
/demo/maintenance/demoserver-locklib:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | ## Copyright (C) 2009  Przemyslaw Pawelczyk <przemoc@gmail.com>
 4 | ## License: GNU General Public License v2, v3
 5 | #
 6 | # Lockable script boilerplate
 7 | 
 8 | ### HEADER ###
 9 | 
10 | LOCKFILE=~/.pma-demoserver.lock
11 | LOCKFD=99
12 | TIMEOUT=600
13 | 
14 | # PRIVATE
15 | _lock()             { flock -$1 -w $TIMEOUT $LOCKFD; }
16 | _no_more_locking()  { _lock u; _lock xn && rm -f $LOCKFILE; }
17 | _prepare_locking()  { eval "exec $LOCKFD>\"$LOCKFILE\""; trap _no_more_locking EXIT; }
18 | 
19 | # ON START
20 | _prepare_locking
21 | 
22 | # PUBLIC
23 | exlock_now()        { _lock xn; }  # obtain an exclusive lock immediately or fail
24 | exlock()            { _lock x; }   # obtain an exclusive lock
25 | shlock()            { _lock s; }   # obtain a shared lock
26 | unlock()            { _lock u; }   # drop a lock
27 | 


--------------------------------------------------------------------------------
/demo/sql/privileges.sql:
--------------------------------------------------------------------------------
 1 | GRANT USAGE ON mysql.* TO 'pma'@'192.168.30.%' IDENTIFIED BY 'heslo';
 2 | GRANT SELECT (
 3 | Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
 4 | Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
 5 | File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
 6 | Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
 7 | Execute_priv, Repl_slave_priv, Repl_client_priv
 8 | ) ON mysql.user TO 'pma'@'192.168.30.%';
 9 | GRANT SELECT ON mysql.db TO 'pma'@'192.168.30.%';
10 | GRANT SELECT ON mysql.host TO 'pma'@'192.168.30.%';
11 | GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
12 | ON mysql.tables_priv TO 'pma'@'192.168.30.%';
13 | GRANT SELECT, INSERT, UPDATE, DELETE ON phpmyadmin.* TO 'pma'@'192.168.30.%';
14 | 
15 | 
16 | CREATE USER 'root'@'192.168.30.%' IDENTIFIED BY '';
17 | GRANT ALL PRIVILEGES ON *.* TO 'root'@'192.168.30.%';
18 | 


--------------------------------------------------------------------------------
/demo/sql/run-mysql:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | # phpMyAdmin configuraiton storage
 4 | mysql -uroot < create_tables.sql
 5 | 
 6 | # Sakila
 7 | mysql -uroot < sakila-db/sakila-schema.sql
 8 | mysql -uroot < sakila-db/sakila-data.sql
 9 | 
10 | # Menagerie
11 | cd menagerie-db
12 | mysql -uroot <<EOT
13 | DROP SCHEMA IF EXISTS menagerie;
14 | CREATE DATABASE menagerie;
15 | USE menagerie;
16 | SOURCE cr_pet_tbl.sql;
17 | SOURCE ins_puff_rec.sql;
18 | SOURCE cr_event_tbl.sql;
19 | EOT
20 | mysqlimport --local menagerie event.txt > /dev/null
21 | mysqlimport --local menagerie pet.txt > /dev/null
22 | cd ..
23 | 
24 | # World database
25 | mysql -uroot <<EOT
26 | DROP SCHEMA IF EXISTS world;
27 | CREATE DATABASE world;
28 | USE world;
29 | SOURCE world.sql;
30 | EOT
31 | 
32 | # OpenGIS data
33 | mysql -uroot <<EOT
34 | DROP SCHEMA IF EXISTS opengis;
35 | CREATE DATABASE opengis;
36 | USE opengis;
37 | SOURCE opengis.sql;
38 | SOURCE world_borders.sql;
39 | EOT
40 | 


--------------------------------------------------------------------------------
/infrastructure/sentry/README.md:
--------------------------------------------------------------------------------
 1 | # phpMyAdmin Sentry instance
 2 | 
 3 | ## Required
 4 | 
 5 | - `docker`
 6 | - `docker-compose`
 7 | 
 8 | ## Initialization
 9 | 
10 | Copy `.env.dist` to `.env.`, fill the values.
11 | 
12 | Run `./dockerl exec sentry sentry upgrade` to apply the migrations.
13 | 
14 | The CLI will ask if you want to create an user, say "Y" and fill the email and password.
15 | 
16 | If you missed your chance, use this command to have another one: `./dockerl exec sentry sentry createuser`
17 | 
18 | Run `./dockerl exec sentry pip install sentry-slack` to install the Sentry Slack integration.
19 | Run `./dockerl exec sentry pip install sentry-github` to install the Sentry GitHub integration.
20 | 
21 | Login into http://localhost:9000/ or something similar.
22 | 
23 | ## Start it
24 | 
25 | Run `./dockerl up` or `./dockerl up -d` for detached mode.
26 | 
27 | This command is a shortcut to docker compose with the right project name.
28 | 


--------------------------------------------------------------------------------
/hooks/config-example.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | define('GITHUB_HOOK_SECRET', 'xxxxxxxxxxxxxxREPLACEMExxxxxxxxxxxxxxxxxx');
 4 | define('GITHUB_USERNAME', 'phpmyadmin-bot');
 5 | define('GITHUB_TOKEN', 'xxxxxxxxxxxxxxREPLACEMExxxxxxxxxxxxxxxxxx');// https://github.com/settings/tokens/new scopes: repo, workflow
 6 | define('SMTP_SEND_TO', 'maillist@example.org');
 7 | define('SMTP_SEND_FROM_EMAIL', 'mail@example.org');// Optional
 8 | define('SMTP_SEND_BACK_TO', 'maillist@example.org');// Optional
 9 | define('SMTP_HEADERS', [ 'Approved' => 'Secret' ]);// Optional
10 | define('SMTP_HOST', 'smtp.example.org');// Optional, if empty all SMTP_* below will be skipped
11 | define('SMTP_PORT', 587);
12 | define('SMTP_MODE', 'tls');// ssl or tls
13 | define('SMTP_USERNAME', 'mail@example.org');
14 | define('SMTP_PASSWORD', 'P@ssw0rd12345');
15 | 
16 | define('WEBSITE_HOOK', 'https://example.org/replaceme-by-an-url');
17 | define('DOCS_HOOK', 'https://example.org/replaceme-by-an-url');
18 | 


--------------------------------------------------------------------------------
/demo/maintenance/mysql-tester:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Script to check MySQL/MariaDB server status
 3 | 
 4 | if [ -z "$1" -o -z "$2" ] ; then
 5 | 	echo "Usage: mysql-tester NAME ADDRESS"
 6 | 	exit 1
 7 | fi
 8 | 
 9 | # Test Debian maintenance user
10 | if ! ssh -xka2 demo-$1 /usr/bin/mysqladmin status 2> /dev/null ; then
11 |     exit 1
12 | fi
13 | 
14 | # Test root user
15 | if ! mysql -uroot -h $2 -e 'SHOW DATABASES' 2> /dev/null ; then
16 |     exit 2
17 | fi
18 | 
19 | # Test root user privileges
20 | if ! mysql -uroot -h $2 -e 'SELECT * FROM mysql.user' 2> /dev/null ; then
21 |     exit 2
22 | fi
23 | 
24 | # Test pma user
25 | if ! mysql -upma -pheslo -h $2 -e 'SHOW DATABASES' 2> /dev/null ; then
26 |     exit 3
27 | fi
28 | 
29 | # Test configuration storage
30 | if ! mysql -uroot -h $2 -e 'USE phpmyadmin' 2> /dev/null ; then
31 |     exit 4
32 | fi
33 | if [ `mysql -uroot -h $2 -e 'SHOW TABLES FROM phpmyadmin' | wc -l` -ne 20 ] ; then
34 |     exit 5
35 | fi
36 | 
37 | exit 0
38 | 


--------------------------------------------------------------------------------
/hooks/create_release.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * GitHub webhook to create github releases for composer packages.
 4 |  */
 5 | 
 6 | error_reporting(E_ALL);
 7 | 
 8 | define('PMAHOOKS', true);
 9 | 
10 | require_once __DIR__ . '/lib/github.php';
11 | 
12 | github_verify_post();
13 | 
14 | /* Parse JSON */
15 | $data = json_decode($_POST['payload'], true);
16 | 
17 | if (isset($data['zen']) && isset($data['hook']) && isset($data['hook_id'])) {
18 |     json_response(array('pong' => true));
19 |     die();
20 | }
21 | 
22 | if ($data['ref_type'] != 'tag') {
23 |     fail('Not a tag: ' . $data['ref_type']);
24 | }
25 | 
26 | $version = $data['ref'];
27 | $tag = $data['ref'];
28 | 
29 | /* Strip v prefix used on some repos */
30 | if (substr($version, 0, 1) === 'v') {
31 |     $version = substr($version, 1);
32 | }
33 | 
34 | /* Check version name */
35 | if (preg_match('/^[0-9.-]+$/', $version) === 0) {
36 |     fail('Not a version tag!');
37 | }
38 | 
39 | $result = github_make_release(
40 |     $data['repository']['full_name'],
41 |     $tag,
42 |     $version,
43 |     'Released version ' . $version
44 | );
45 | 
46 | json_response($result);
47 | 


--------------------------------------------------------------------------------
/documentation-po-update:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | # Fail on error or undefined variable
 4 | set -e
 5 | set -u
 6 | 
 7 | # Updates phpMyAdmin documentation
 8 | 
 9 | if [ -z "${1:-}" ] || [ ! -d "${1:-}" ]; then
10 |     echo "Usage documentation-po-update ~/localized_docs/"
11 |     exit 1
12 | fi
13 | 
14 | WORKDIR="${1}"
15 | 
16 | if [ ! -d "$WORKDIR" ] ; then
17 |     git clone git@github.com:phpmyadmin/localized_docs.git "$WORKDIR"
18 | fi
19 | 
20 | cd "$WORKDIR"
21 | 
22 | # Update localized_docs repo
23 | git pull -q
24 | git submodule update --init -q
25 | 
26 | cd phpmyadmin
27 | 
28 | # Check for remote changes in phpmyadmin repo
29 | oldrev=`git log -n 1 --format=format:%H @`
30 | git fetch -q origin
31 | newrev=`git log -n 1 --format=format:%H origin/master`
32 | 
33 | # Is there some diff?
34 | if git diff --stat --exit-code $oldrev..$newrev -- docs/ ; then
35 |     exit 0
36 | fi
37 | 
38 | cd ..
39 | 
40 | # Lock Weblate and commit changes
41 | wlc lock
42 | wlc push
43 | 
44 | # Pull changes from weblate
45 | git pull
46 | 
47 | # Update phpmyadmin submodule
48 | git submodule update --remote
49 | git commit -a -m 'Updated phpMyAdmin repository'
50 | 
51 | # Update po files
52 | make
53 | git add .
54 | git commit -m 'Update po files'
55 | 
56 | # Publish changes
57 | git push
58 | 
59 | # Unlock Weblate
60 | wlc unlock
61 | 


--------------------------------------------------------------------------------
/demo/php/config-config-nopmadb.inc.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | require('/home/demo/scripts/demo/php/config-common.inc.php');
 3 | $cfg['ZeroConf'] = false;
 4 | 
 5 | $cfg['Servers'][1]['extension'] = 'mysqli';
 6 | $cfg['Servers'][1]['auth_type'] = 'config';
 7 | $cfg['Servers'][2]['extension'] = 'mysqli';
 8 | $cfg['Servers'][2]['auth_type'] = 'config';
 9 | 
10 | 
11 | unset($cfg['Servers'][1]['bookmarktable']);
12 | unset($cfg['Servers'][1]['relation']);
13 | unset($cfg['Servers'][1]['table_info']);
14 | unset($cfg['Servers'][1]['table_coords']);
15 | unset($cfg['Servers'][1]['pdf_pages']);
16 | unset($cfg['Servers'][1]['column_info']);
17 | unset($cfg['Servers'][1]['history']);
18 | unset($cfg['Servers'][1]['designer_coords']);
19 | unset($cfg['Servers'][1]['controluser']);
20 | unset($cfg['Servers'][1]['controlpass']);
21 | unset($cfg['Servers'][1]['pmadb']);
22 | 
23 | unset($cfg['Servers'][2]['bookmarktable']);
24 | unset($cfg['Servers'][2]['relation']);
25 | unset($cfg['Servers'][2]['table_info']);
26 | unset($cfg['Servers'][2]['table_coords']);
27 | unset($cfg['Servers'][2]['pdf_pages']);
28 | unset($cfg['Servers'][2]['column_info']);
29 | unset($cfg['Servers'][2]['history']);
30 | unset($cfg['Servers'][2]['designer_coords']);
31 | unset($cfg['Servers'][2]['controluser']);
32 | unset($cfg['Servers'][2]['controlpass']);
33 | unset($cfg['Servers'][2]['pmadb']);
34 | ?>
35 | 


--------------------------------------------------------------------------------
/develdocs/build.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | # Script to generate phpdoc documentation of phpMyAdmin and publish it
 4 | # on develdocs.phpmyadmin.net
 5 | 
 6 | set -e
 7 | 
 8 | # Update scripts
 9 | BUILDER_ROOT=${BUILDER_ROOT:-"/home/builder"}
10 | BUILDER_REPO="$BUILDER_ROOT/${BUILDER_REPO_NAME:-scripts}"
11 | cd "$BUILDER_REPO"
12 | git pull -q
13 | 
14 | # Update doc build environment
15 | cd develdocs
16 | composer update --quiet
17 | 
18 | # Generate docs
19 | for repo in phpmyadmin sql-parser motranslator shapefile simple-math ; do
20 |     cd "$BUILDER_ROOT/$repo"
21 |     git pull -q
22 |     # Clean output
23 |     rm -rf "$BUILDER_REPO/develdocs/output/$repo/"
24 |     # Generate config file
25 |     nice -19 "$BUILDER_REPO/develdocs/doctum.php" \
26 |     --root "$BUILDER_ROOT/$repo" \
27 |     --build-dir "$BUILDER_REPO/develdocs/output/$repo/" \
28 |     --cache-dir "$BUILDER_REPO/develdocs/tmp/$repo/" \
29 |     --docs-branch "master" \
30 |     --slug "phpmyadmin/$repo" \
31 |     --base-url "https://develdocs.phpmyadmin.net/$repo/" \
32 |     --output-config "$BUILDER_REPO/develdocs/doctum-$repo.php"
33 |     # Render
34 |     nice -19 "$BUILDER_REPO/develdocs/vendor/bin/doctum.php" update --force --no-progress --no-ansi --ignore-parse-errors "$BUILDER_REPO/develdocs/doctum-$repo.php"
35 |     # Delete config file
36 |     rm "$BUILDER_REPO/develdocs/doctum-$repo.php"
37 | done
38 | 


--------------------------------------------------------------------------------
/website/daily-snapshots:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Script to generate daily snapshots
 3 | set -eux
 4 | 
 5 | if [ -z "${1:-}" ] || [ ! -d "${1:-}" ]; then
 6 |     echo "Usage daily-snapshots ~/phpmyadmin.git"
 7 |     exit 1
 8 | fi
 9 | 
10 | # phpMyAdmin working copy
11 | cd "${1}"
12 | 
13 | # Delete any local changes
14 | git reset --hard
15 | 
16 | # Update to have latest create-release.sh
17 | git pull -q
18 | 
19 | # Remove current release files
20 | rm -rf release
21 | 
22 | # Create snapshots
23 | # Change branch to be sure to have a working release script
24 | git checkout QA_5_2
25 | # Destroy any possible local changes
26 | git reset --hard
27 | # Force an update
28 | git pull --ff-only
29 | #TODO: When changing to QA_6_0, update from ./scripts/ to ./bin/internal/
30 | ./scripts/create-release.sh --daily 5.2+snapshot QA_5_2
31 | # Destroy any possible local changes
32 | git reset --hard
33 | git checkout -
34 | git checkout master
35 | # Destroy any possible local changes
36 | git reset --hard
37 | # Force an update
38 | git pull --ff-only
39 | ./bin/internal/create-release.sh --daily 6.0+snapshot master
40 | 
41 | # Storage directory
42 | mkdir -p /mnt/storage/files/snapshots/
43 | 
44 | # Remove old snapshots
45 | rm -f /mnt/storage/files/snapshots/*
46 | 
47 | # Move new files
48 | mv release/*.* /mnt/storage/files/snapshots/
49 | 
50 | # trigger website scan
51 | sudo -u builder /home/builder/website/manage.py import_files
52 | 


--------------------------------------------------------------------------------
/hooks/README.rst:
--------------------------------------------------------------------------------
 1 | Web hooks for phpMyAdmin
 2 | ========================
 3 | 
 4 | This directory contains various scripts used for development.
 5 | 
 6 | Configuration
 7 | +++++++++++++
 8 | 
 9 | The scripts accessing GitHub need configuration to be able to authorize against
10 | it.
11 | 
12 | Please copy file ``config-example.php`` to ``config.php`` and fill the different variables.
13 | 
14 | All variables that begin with ``SMTP_`` are used by the ``push.php`` script, they are not required if you no not use the ``push.php`` script.
15 | 
16 | 
17 | WebHooks
18 | ++++++++
19 | 
20 | - ``protocol://host/folder/hooks/commits.php`` (``Content-Type: application/x-www-form-urlencoded``) event:``pull_request``
21 | - ``protocol://host/folder/hooks/push.php`` (``Content-Type: application/json``) event:``push``
22 | - ``protocol://host/folder/hooks/docs.php``
23 | - ``protocol://host/folder/hooks/website.php``
24 | - ``protocol://host/folder/hooks/create_release.php`` (``Content-Type: application/x-www-form-urlencoded``) event:``create``
25 | - ``protocol://host/folder/hooks/create.php`` (``Content-Type: application/x-www-form-urlencoded``) event:``create``
26 | 
27 | Scripts
28 | +++++++
29 | 
30 | Commits checker
31 | ---------------
32 | 
33 | The ``commits.php`` is GitHub hook to check that all commits in a pull request
34 | are in a good shape:
35 | 
36 | * all have valid Signed-Off-By line
37 | * the patch does not introduce some of coding style violations
38 |     * tab indentation
39 |     * DOS end of lines
40 |     * trailing whitespace
41 | 


--------------------------------------------------------------------------------
/develdocs/doctum.php:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/php
 2 | <?php
 3 | $_CLI = getopt('', ['slug:', 'root:', 'base-url:', 'build-dir:', 'cache-dir:', 'docs-branch:', 'output-config:', 'title::', 'title-of-composer']);
 4 | 
 5 | $SOURCE = 'src';
 6 | 
 7 | if (is_dir($_CLI['root'] . '/src') === false) {
 8 |     $SOURCE = 'libraries';
 9 | }
10 | 
11 | $output = <<<'EOT'
12 | <?php
13 | /**
14 |  * This file has been generated by phpmyadmin/scripts/develdocs/build.sh
15 |  * @see https://github.com/phpmyadmin/scripts/blob/master/develdocs/doctum.php
16 |  * @see https://github.com/phpmyadmin/scripts/blob/master/develdocs/build.sh
17 |  */
18 | use Doctum\Doctum;
19 | use Symfony\Component\Finder\Finder;
20 | use Doctum\RemoteRepository\GitHubRemoteRepository;
21 | 
22 | $iterator = Finder::create()
23 |     ->files()
24 |     ->name('*.php')
25 |     ->in('%s');
26 | 
27 | return new Doctum($iterator, [
28 |     'title'                => json_decode(file_get_contents('%s'))->description,
29 |     'build_dir'            => '%s',
30 |     'cache_dir'            => '%s',
31 |     'version'              => '%s',
32 |     'remote_repository'    => new GitHubRemoteRepository('%s', '%s'),
33 |     'base_url'             => '%s',
34 | ]);
35 | EOT;
36 | 
37 | $root = rtrim($_CLI['root'], '/') . '/';
38 | 
39 | $output = sprintf(
40 |     $output,
41 |     $root . $SOURCE,
42 |     $root . 'composer.json',
43 |     $_CLI['build-dir'],
44 |     $_CLI['cache-dir'],
45 |     $_CLI['docs-branch'],
46 |     $_CLI['slug'],
47 |     $root,
48 |     $_CLI['base-url']
49 | );
50 | 
51 | file_put_contents($_CLI['output-config'], $output);
52 | 


--------------------------------------------------------------------------------
/list-top-authors:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/python
 2 | 
 3 | import git
 4 | import sys
 5 | import time
 6 | 
 7 | if len(sys.argv) < 4:
 8 |     print 'Usage: list-top-authors repo startrev threshold'
 9 |     print
10 |     print 'Lists authors of commits in given repo, starting with startrev'
11 |     print 'The threshold defines minimal amount of commits author needs to be listed'
12 |     sys.exit()
13 | 
14 | threshold = int(sys.argv[3])
15 | 
16 | repo = git.Repo(sys.argv[1])
17 | 
18 | authors = {}
19 | 
20 | for commit in repo.iter_commits('%s..master' % sys.argv[2]):
21 |     author = commit.author.name
22 |     full_author = '%s <%s>' % (commit.author.name, commit.author.email)
23 |     date = commit.authored_date
24 |     if not author in authors:
25 |         authors[author] = {
26 |             'first': date,
27 |             'last': date,
28 |             'count': 1,
29 |             'name': full_author,
30 |         }
31 |     else:
32 |         if authors[author]['first'] > date:
33 |             authors[author]['first'] = date
34 |         if authors[author]['last'] < date:
35 |             authors[author]['last'] = date
36 |         authors[author]['count'] += 1
37 | 
38 | authors = authors.values()
39 | authors.sort(lambda a, b: -1 * cmp(a['count'], b['count']))
40 | 
41 | for a in authors:
42 |     if a['count'] < threshold:
43 |         break
44 |     first = time.strftime("%b %Y", time.gmtime(a['first']))
45 |     last = time.strftime("%b %Y", time.gmtime(a['last']))
46 |     # Ignore people with short interval
47 |     if first == last:
48 |         continue
49 |     print '%s (%s - %s)' % (a['name'].encode('utf-8'), first, last)
50 | 


--------------------------------------------------------------------------------
/hooks/create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * GitHub webhook to create github releases for tags.
 4 |  */
 5 | 
 6 | error_reporting(E_ALL);
 7 | 
 8 | define('PMAHOOKS', true);
 9 | 
10 | require_once __DIR__ . '/lib/github.php';
11 | 
12 | github_verify_post();
13 | 
14 | /* Parse JSON */
15 | $data = json_decode($_POST['payload'], true);
16 | 
17 | if (isset($data['zen']) && isset($data['hook']) && isset($data['hook_id'])) {
18 |     json_response(array('pong' => true));
19 |     die();
20 | }
21 | 
22 | if ($data['ref_type'] != 'tag') {
23 |     fail('Not a tag', 204);
24 | }
25 | 
26 | $parts = explode('_', $data['ref']);
27 | 
28 | if ($parts[0] != 'RELEASE') {
29 |     fail('Not a RELEASE', 204);
30 | }
31 | 
32 | if (! ctype_digit($parts[count($parts) - 1])) {
33 |     fail('Not a final release', 204);
34 | }
35 | // Remove RELEASE prefix
36 | $parts = array_slice($parts, 1);
37 | 
38 | foreach ($parts as $part) {
39 |     if (! ctype_digit($part)) {
40 |         fail('Not a release!', 204);
41 |     }
42 | }
43 | 
44 | $version = implode('.', $parts);
45 | 
46 | $major_version = implode('.', array_slice($parts, 0, 3));
47 | 
48 | $result = github_make_release(
49 |     $data['repository']['full_name'],
50 |     $data['ref'],
51 |     $version,
52 |     'phpMyAdmin release ' . $version . "\n\n" .
53 |     '* [Download](https://www.phpmyadmin.net/files/' . $version . '/)' . "\n" .
54 |     '* [Release notes](https://www.phpmyadmin.net/files/' . $version . '/)' . "\n" .
55 |     '* [Fixed issues](https://github.com/phpmyadmin/phpmyadmin/issues?q=is%3Aclosed+is%3Aissue+milestone%3A' . $major_version . ")\n"
56 | );
57 | 
58 | json_response($result);
59 | 


--------------------------------------------------------------------------------
/demo/bin/pma-revision-info:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | remote_url=`git remote show -n origin | grep 'Fetch' | sed 's/.*URL: //'`
 4 | ref=$(git symbolic-ref -q HEAD || git name-rev --name-only HEAD 2>/dev/null)
 5 | ref=${ref#refs/heads/}
 6 | rev=`git describe --always`
 7 | fullrev=`git log -1 | head -n 1 | awk '{print $2}'`
 8 | if [ "$remote_url" = "https://github.com/phpmyadmin/phpmyadmin.git" ] ; then
 9 |     repobase="https://github.com/phpmyadmin/phpmyadmin/commit/"
10 |     repobranchbase="https://github.com/phpmyadmin/phpmyadmin/tree/"
11 |     reponame=''
12 | elif echo "$remote_url" | grep -q "https://github.com/" ; then
13 |     repobase=`echo $remote_url | sed 's@https://github.com/\(.*\)/\(.*\).git@https://github.com/\1/\2/commit/@'`
14 |     repobranchbase=`echo $remote_url | sed 's@https://github.com/\(.*\)/\(.*\).git@https://github.com/\1/\2/tree/@'`
15 |     reponame=`echo $remote_url | sed 's@https://github.com/\(.*\)/\(.*\).git@\1@'`
16 | else
17 |     repobase=`echo $remote_url | sed 's@git://repo.or.cz@http://repo.or.cz/w@'`/commitdiff/
18 |     repobranchbase=`echo $remote_url | sed 's@git://repo.or.cz@http://repo.or.cz/w@'`/shortlog/refs/heads/
19 |     reponame=''
20 | fi
21 | cat > revision-info.php.tmp <<EOT
22 | <?php
23 | \$revision = '$rev';
24 | \$fullrevision = '$fullrev';
25 | \$repobase = '$repobase';
26 | \$reponame = '$reponame';
27 | \$repobranchbase = '$repobranchbase';
28 | \$branch = '$ref';
29 | return array(
30 |     'revision' => '$rev',
31 |     'revisionUrl' => '$repobase$fullrev',
32 |     'branch' => '$ref',
33 |     'branchUrl' => '$repobranchbase$ref'
34 | );
35 | EOT
36 | mv revision-info.php.tmp revision-info.php
37 | 


--------------------------------------------------------------------------------
/monitoring/check_phpmyadmin_daily_snapshots.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python3
 2 | 
 3 | # I suggest creating a venv for this. I did it with `python3 -m venv daily_snapshot_venv` then source that with `source daily_snapshot_venv/bin/activate`.
 4 | # Install 'beautifulsoup4' to the venv
 5 | 
 6 | # This program checks that the phpMyAdmin daily downloads are within a day or two of the current time.
 7 | # We allow an extra day of wiggle room because of the possibility of working in different time zones.
 8 | #
 9 | # Written by Isaac Bennetch <bennetch@gmail.com>
10 | 
11 | import urllib.request
12 | try:
13 |     from bs4 import BeautifulSoup
14 | except ModuleNotFoundError:
15 |     print("The BeautifulSoup module is not available. Please make sure you have the proper module or are running the correct venv.")
16 |     raise SystemExit
17 | import datetime
18 | 
19 | #############
20 | # Main code #
21 | #############
22 | 
23 | 
24 | download_url = 'https://www.phpmyadmin.net/downloads/'
25 | 
26 | page = urllib.request.urlopen(download_url)
27 | soup = BeautifulSoup(page, 'html.parser')
28 | full_text = soup.get_text()
29 | split = full_text.split("generated")
30 | 
31 | today_date = datetime.date.today()
32 | 
33 | # Process each instance of the keyword on the page, because we can have multiple QA and master versions
34 | for substring in split:
35 |   # Take only the date, not the entire page following it
36 |   generated_date = substring.split()[0]
37 |   # Strip off the trailing comma
38 |   if generated_date.endswith(','):
39 |     generated_date = generated_date[:-1]
40 |   if generated_date != 'phpMyAdmin':
41 |     converted_date = datetime.datetime.strptime(generated_date, '%Y-%m-%d').date()
42 |     difference = today_date - converted_date
43 |     # We give an extra day as a buffer to account for time zones
44 |     if difference > datetime.timedelta(days=1):
45 |       print("Problem found")
46 |       print("Current date: " + today_date.strftime('%Y-%m-%d'))
47 |       print("Snapshot date: " + generated_date)
48 |     else:
49 |       print("Everything is groovy")
50 | 
51 | 


--------------------------------------------------------------------------------
/monitoring/check_phpmyadmin_docker.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # This script will get a list of currently supported versions from phpmyadmin.net.
 4 | # For each version, it pulls the Docker image for each flavor, including major and minor
 5 | # version shortcuts (5, 5.0, and 5.0.0). We check that the expected version is listed in ChangeLog.
 6 | #
 7 | # Future versions could use jq to parse package.json for the "version" field
 8 | #
 9 | # Written by Isaac Bennetch <bennetch@gmail.com>
10 | 
11 | supported_versions=$(curl -fsSL 'https://www.phpmyadmin.net/home_page/version.json'|jq -r '.releases|.[]|.version')
12 | 
13 | if [ "$1" == "-h" ] || [ "$1" == "--help" ]
14 | then
15 |   echo "Checks whether the docker builds are current to the versions presented in the version.json file from phpmyadmin.net"
16 |   echo ""
17 |   echo "Possible arguments:"
18 |   echo "  -v --verbose    Prints some progress output (usually runs silently)"
19 |   echo "  -h --help       Prints this help message"
20 |   exit ""
21 | fi
22 | 
23 | if [ "$1" == "-v" ] || [ "$1" == "--verbose" ]
24 | then
25 |   verbose=true
26 | else
27 |   verbose=false
28 | fi
29 | 
30 | test_version() {
31 | 	ver=$1
32 |   nodots=${ver//[-.]/}
33 |   container=ptest-$nodots
34 |   for flavor in "$ver" "$ver-fpm" "$ver-fpm-alpine"
35 |   do
36 |     if [ "$verbose" == true ]
37 |     then
38 |       echo "Processing $flavor"
39 |     fi
40 | 
41 |     docker pull -q phpmyadmin/phpmyadmin:"$flavor" > /dev/null
42 |     docker run --name "$container" -d phpmyadmin/phpmyadmin:"$flavor" > /dev/null
43 |     docker exec -t "$container" grep "$ver" ChangeLog > /dev/null || echo "Failed to find version $ver in $container"
44 |     docker container stop "$container" > /dev/null
45 |     docker container rm "$container" > /dev/null
46 |   done
47 | }
48 | 
49 | while read -r full_version
50 | # https://unix.stackexchange.com/questions/9784/how-can-i-read-line-by-line-from-a-variable-in-bash
51 | do
52 | 	major="${full_version:0:1}"
53 | 	minor="${full_version:0:3}"
54 | 	test_version "$full_version"
55 | 	test_version "$minor"
56 | 	test_version "$major"
57 | done < <(printf '%s\n' "$supported_versions")
58 | 


--------------------------------------------------------------------------------
/hooks/push.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use PHPMailer\PHPMailer\PHPMailer;
 4 | use PHPMailer\PHPMailer\Exception;
 5 | 
 6 | /**
 7 |  * GitHub webhook to send emails using push event
 8 |  */
 9 | 
10 | error_reporting(E_ALL);
11 | 
12 | define('PMAHOOKS', true);
13 | 
14 | require_once __DIR__ . '/lib/github.php';
15 | 
16 | if ( !is_file(__DIR__ . '/vendor/autoload.php')) {
17 |     fail('Run composer install');
18 |     exit;
19 | }
20 | 
21 | //Load Composer's autoloader
22 | require_once __DIR__ . '/vendor/autoload.php';
23 | 
24 | github_verify_post();
25 | 
26 | 
27 | $inputData = json_decode(file_get_contents('php://input'));
28 | 
29 | if (json_last_error() !== 0) {
30 |     fail("JSON body was not well formed.");
31 |     exit;
32 | }
33 | 
34 | if (isset($inputData->zen) && isset($inputData->hook) && isset($inputData->hook_id)) {
35 |     json_response(array('pong' => true));
36 |     die();
37 | }
38 | 
39 | $data = github_webhook_push($inputData);
40 | 
41 | 
42 | $mail = new PHPMailer(true);
43 | try {
44 | 
45 |     $mail->SMTPDebug  = 0;
46 |     $mail->CharSet = 'utf-8';
47 |     $mail->Encoding = 'base64';
48 | 
49 |     if (defined('SMTP_HOST') && !empty(SMTP_HOST)) {
50 |         $mail->isSMTP();
51 |         $mail->Host       = SMTP_HOST;
52 |         $mail->SMTPAuth   = true;
53 |         $mail->Username   = SMTP_USERNAME;
54 |         $mail->Password   = SMTP_PASSWORD;
55 |         $mail->SMTPSecure = SMTP_MODE;
56 |         $mail->Port       = SMTP_PORT;
57 |     }
58 | 
59 |     if (defined('SMTP_SEND_FROM_EMAIL')) {
60 |         $mail->setFrom(SMTP_SEND_FROM_EMAIL, $data->authorName);
61 |     } else {
62 |         $mail->setFrom($data->authorEmail, $data->authorName);
63 |     }
64 | 
65 |     $mail->addAddress(SMTP_SEND_TO);
66 | 
67 |     if (defined('SMTP_SEND_BACK_TO')) {
68 |         $mail->addReplyTo(SMTP_SEND_BACK_TO);
69 |     }
70 | 
71 |     if (defined('SMTP_HEADERS') && is_array(SMTP_HEADERS)) {
72 |         foreach (SMTP_HEADERS as $name => $value) {
73 |             $mail->addCustomHeader($name, $value);
74 |         }
75 |     }
76 | 
77 |     $mail->Subject  = '[phpMyAdmin Git] [' . $data->repoName. '] ';
78 |     $mail->Subject .= $data->headCommitShortHash . ': ' . $data->headCommitTitle;
79 |     $mail->Body     = $data->emailBody;
80 | 
81 |     $mail->send();
82 |     json_response($data, 'success', 'Message has been sent');
83 | } catch (Exception $e) {
84 |     fail('Message could not be sent. Mailer Error: ' . $mail->ErrorInfo);
85 | }
86 | 


--------------------------------------------------------------------------------
/cleanup-untranslated-po:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/python
 2 | '''
 3 | This script removes strings which are not translated in a po file. It uses
 4 | whitelist to prevent removal of things which might possibly be same in
 5 | different languages.
 6 | '''
 7 | 
 8 | import glob
 9 | from translate.storage import factory
10 | 
11 | WHITELIST = frozenset([
12 |     'Microsoft Word 2000',
13 |     'Excel 97-2003 XLS Workbook',
14 |     'Excel 2007 XLSX Workbook',
15 |     'Open Document',
16 |     'Open Document Spreadsheet',
17 |     'Open Document Text',
18 |     'HTTP Realm',
19 |     'Cardinality',
20 |     'Microsoft Office',
21 |     'Texy! text',
22 |     'Import / export',
23 |     'Well Known Text',
24 |     'Well Known Binary',
25 |     'horizontal',
26 |     '%B %d, %Y at %I:%M %p',
27 |     'SQL Query box',
28 |     'case-insensitive',
29 |     'case-sensitive',
30 |     'SQL Validator',
31 |     'calendar-month-year',
32 |     'Administration',
33 |     'Partition %s',
34 |     'Distribution',
35 |     'tmp_table_size vs. max_heap_table_size',
36 |     'Thread cache',
37 |     'phpMyAdmin homepage',
38 |     'ENUM/SET editor',
39 |     'Logo link URL',
40 |     'Logo link target',
41 |     'Server socket',
42 |     'InnoDB Status',
43 |     'Master status',
44 |     'Slave status',
45 |     'Routine parameters',
46 |     'Edit routine',
47 |     'Edit trigger',
48 |     'Start Monitor',
49 |     'Delayed inserts',
50 |     'Flush query cache',
51 |     'Blowfish secret',
52 |     'Flush (close) all tables',
53 |     'Analyze table',
54 |     'Validate SQL',
55 |     'Documentation',
56 |     'Flush the table (FLUSH)',
57 |     'Data Dictionary',
58 |     'GZip output buffering',
59 |     'Browser transformation',
60 |     'Database server',
61 |     'Original position',
62 |     'Storage Engine',
63 |     'Storage Engines',
64 |     'Password Hashing',
65 |     'Control host',
66 | 
67 | ])
68 | 
69 | for f in glob.glob('po/*.po'):
70 |     if f == 'po/en_GB.po':
71 |         continue
72 |     removed = 0
73 |     store = factory.getobject(f)
74 |     for unit in store.units:
75 |         if not unit.istranslated():
76 |             continue
77 |         if len(unit.source.strings) > 1:
78 |             continue
79 |         s = str(unit.source)
80 |         if s.isupper() or len(s) < 12:
81 |             continue
82 |         if s in WHITELIST:
83 |             continue
84 |         if s == unit.target:
85 |             unit.target = ''
86 |             removed += 1
87 | 
88 |     if removed > 0:
89 |         print 'Removed %d in %s' % (removed, f)
90 |         store.save()
91 | 


--------------------------------------------------------------------------------
/infrastructure/sentry/docker-compose.yml:
--------------------------------------------------------------------------------
 1 | version: '2.3'
 2 | 
 3 | services:
 4 |   redis:
 5 |     restart: on-failure:5
 6 |     image: redis:6.0-alpine
 7 |     healthcheck:
 8 |         test: ["CMD", "redis-cli", "ping"]
 9 |         interval: 1s
10 |         timeout: 3s
11 |         retries: 30
12 | 
13 |   postgres:
14 |     restart: on-failure:5
15 |     image: postgres:13-alpine
16 |     healthcheck:
17 |       test: ["CMD-SHELL", "pg_isready -U sentry"]
18 |       interval: 10s
19 |       timeout: 5s
20 |       retries: 5
21 |       start_period: 10s
22 |     environment:
23 |       POSTGRES_USER: sentry
24 |       POSTGRES_PASSWORD: "${POSTGRES_PASSWORD}"
25 |       POSTGRES_DB: sentry
26 |     volumes:
27 |      - ${POSTGRES_DATA_VOLUME}:/var/lib/postgresql/data
28 |   smtp:
29 |     restart: unless-stopped
30 |     # Use this value to have correct SMTP HELO value
31 |     hostname: hertz.phpmyadmin.net
32 |     image: tianon/exim4
33 | 
34 |   sentry:
35 |     image: sentry:9.1.2
36 |     depends_on:
37 |       postgres:
38 |         condition: service_healthy
39 |       redis:
40 |         condition: service_healthy
41 |     ports:
42 |      - 9000:9000
43 |     environment:
44 |       SENTRY_SECRET_KEY: "${SENTRY_SECRET_KEY}"
45 |       SENTRY_POSTGRES_HOST: postgres
46 |       SENTRY_DB_USER: sentry
47 |       SENTRY_DB_PASSWORD: "${POSTGRES_PASSWORD}"
48 |       SENTRY_REDIS_HOST: redis
49 |       SENTRY_FILESTORE_DIR: /data/filestorage
50 |       SENTRY_SERVER_EMAIL: "${SENTRY_SERVER_EMAIL}"
51 |       SENTRY_EMAIL_HOST: smtp
52 |     volumes:
53 |      - ${SENTRY_DATA_VOLUME}:/data
54 | 
55 |   cron:
56 |     image: sentry:9.1.2
57 |     depends_on:
58 |       postgres:
59 |         condition: service_healthy
60 |       redis:
61 |         condition: service_healthy
62 |     command: "sentry run cron"
63 |     environment:
64 |       SENTRY_SECRET_KEY: "${SENTRY_SECRET_KEY}"
65 |       SENTRY_POSTGRES_HOST: postgres
66 |       SENTRY_DB_USER: sentry
67 |       SENTRY_DB_PASSWORD: "${POSTGRES_PASSWORD}"
68 |       SENTRY_REDIS_HOST: redis
69 |       SENTRY_FILESTORE_DIR: /data/filestorage
70 |       SENTRY_SERVER_EMAIL: "${SENTRY_SERVER_EMAIL}"
71 |       SENTRY_EMAIL_HOST: smtp
72 |     volumes:
73 |      - ${SENTRY_DATA_VOLUME}:/data
74 | 
75 |   worker:
76 |     image: sentry:9.1.2
77 |     depends_on:
78 |       postgres:
79 |         condition: service_healthy
80 |       redis:
81 |         condition: service_healthy
82 |     command: "sentry run worker"
83 |     environment:
84 |       SENTRY_SECRET_KEY: "${SENTRY_SECRET_KEY}"
85 |       SENTRY_POSTGRES_HOST: postgres
86 |       SENTRY_DB_USER: sentry
87 |       SENTRY_DB_PASSWORD: "${POSTGRES_PASSWORD}"
88 |       SENTRY_REDIS_HOST: redis
89 |       SENTRY_FILESTORE_DIR: /data/filestorage
90 |       SENTRY_SERVER_EMAIL: "${SENTRY_SERVER_EMAIL}"
91 |       SENTRY_EMAIL_HOST: smtp
92 |     volumes:
93 |      - ${SENTRY_DATA_VOLUME}:/data
94 | 


--------------------------------------------------------------------------------
/demo/sql/menagerie-db/README.txt:
--------------------------------------------------------------------------------
 1 | This directory contains files that can be used to set up the menagerie
 2 | database that is used in the tutorial chapter of the MySQL Reference
 3 | Manual.
 4 | 
 5 | These instructions assume that your current working directory is
 6 | the directory that contains the files created by unpacking the
 7 | menagerie.zip or menagerie.tar.gz distribution. Any MySQL programs
 8 | that you use (such as mysql or mysqlimport) should be invoked from
 9 | that directory.
10 | 
11 | To invoke mysql or mysqlimport, either specify the full path name
12 | to the program, or set your PATH environment variable to the bin
13 | directory that contains the programs so that you can invoke them
14 | from anywhere without specifying their full path name. (See your
15 | operating system's help instructions for environment variables.)
16 | The full path name to the programs depends on where MySQL is installed.
17 | 
18 | For the mysql and mysqlimport commands, supply any connection parameters
19 | necessary (host, user, password) on the command line before the database
20 | name.  For more information, see:
21 | 
22 |   https://dev.mysql.com/doc/mysql/en/invoking-programs.html
23 | 
24 | 
25 | First, you must create the menagerie database.  Invoke the mysql program,
26 | and then issue this statement:
27 | 
28 |   mysql> CREATE DATABASE menagerie;
29 | 
30 | If you use a database name different from menagerie in the CREATE
31 | DATABASE statement, use that same name wherever you see menagerie
32 | in the following instructions.
33 | 
34 | Select the menagerie database as the default database:
35 | 
36 |   mysql> USE menagerie;
37 | 
38 | Create the pet table:
39 | 
40 |   mysql> SOURCE cr_pet_tbl.sql
41 | 
42 | Load the pet table:
43 | 
44 |   mysql> LOAD DATA LOCAL INFILE 'pet.txt' INTO TABLE pet;
45 | 
46 | To add Puffball's record, use this command:
47 | 
48 |   mysql> SOURCE ins_puff_rec.sql
49 | 
50 | Create the event table:
51 | 
52 |   mysql> SOURCE cr_event_tbl.sql
53 | 
54 | Load the event table:
55 | 
56 |   mysql> LOAD DATA LOCAL INFILE 'event.txt' INTO TABLE event;
57 | 
58 | 
59 | Alternate procedure:
60 | 
61 | If you want to create and load the tables from your command interpreter
62 | (cmd.exe or command.com in Windows, or your shell in Unix), use the
63 | following commands after using CREATE DATABASE as shown earlier to
64 | create the menagerie database. In these instructions, "shell>"
65 | represents your command interpreter prompt.
66 | 
67 | Create the pet table:
68 | 
69 |   shell> mysql menagerie < cr_pet_tbl.sql
70 | 
71 | To load the pet table, use either of these commands:
72 | 
73 |   shell> mysql menagerie < load_pet_tbl.sql
74 |   shell> mysqlimport --local menagerie pet.txt
75 | 
76 | To add Puffball's record, use this command:
77 | 
78 |   shell> mysql menagerie < ins_puff_rec.sql
79 | 
80 | Create the event table:
81 | 
82 |   shell> mysql menagerie < cr_event_tbl.sql
83 | 
84 | Load the event table:
85 | 
86 |   shell> mysqlimport --local menagerie event.txt
87 | 


--------------------------------------------------------------------------------
/develdocs/output/index.html:
--------------------------------------------------------------------------------
 1 | <!doctype html>
 2 | <html lang="en">
 3 | 
 4 | <head>
 5 |     <meta charset="utf-8">
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 7 |     <meta name="description" content="Auto-generated phpMyAdmin developer documentation">
 8 |     <meta name="author" content="phpMyAdmin team and contributors">
 9 |     <title>phpMyAdmin developer documentation</title>
10 | 
11 |     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.5.0/css/bootstrap.min.css"
12 |         integrity="sha512-rO2SXEKBSICa/AfyhEK5ZqWFCOok1rcgPYfGOqtX35OyiraBg6Xa4NnBJwXgpIRoXeWjcAmcQniMhp22htDc6g=="
13 |         crossorigin="anonymous" />
14 | 
15 | </head>
16 | 
17 | <body>
18 |     <header>
19 |         <div class="navbar navbar-dark bg-dark shadow-sm">
20 |             <div class="container d-flex justify-content-between">
21 |                 <div class="card-footer"></div>
22 |             </div>
23 |         </div>
24 |     </header>
25 | 
26 |     <main role="main">
27 | 
28 |         <section class="jumbotron text-center">
29 |             <div class="container">
30 |                 <h1>phpMyAdmin developer documentation</h1>
31 |                 <p class="lead text-muted">You will find auto-generated documentations for the projects below.</p>
32 |             </div>
33 |         </section>
34 |         <div class="col-12">
35 |             <div class="card-group">
36 |                 <div class="col-1">&nbsp;</div>
37 |                 <div class="card">
38 |                     <div class="card-body">
39 |                         <h5 class="card-title">phpMyAdmin</h5>
40 |                         <p class="card-text">A web interface for MySQL and MariaDB</p>
41 |                     </div>
42 |                     <div class="card-footer text-center"><a href="/phpmyadmin/" class="card-link">Documentation</a>
43 |                     </div>
44 |                 </div>
45 |                 <div class="card">
46 |                     <div class="card-body">
47 |                         <h5 class="card-title">motranslator</h5>
48 |                         <p class="card-text">Translation API for PHP using Gettext MO
49 |                             files</p>
50 |                     </div>
51 |                     <div class="card-footer text-center"><a href="/motranslator/" class="card-link">Documentation</a>
52 |                     </div>
53 |                 </div>
54 |                 <div class="card">
55 |                     <div class="card-body">
56 |                         <h5 class="card-title">shapefile</h5>
57 |                         <p class="card-text">ESRI ShapeFile library for PHP</p>
58 |                     </div>
59 |                     <div class="card-footer text-center"><a href="/shapefile/" class="card-link">Documentation</a></div>
60 |                 </div>
61 |                 <div class="card">
62 |                     <div class="card-body">
63 |                         <h5 class="card-title">sql-parser</h5>
64 |                         <p class="card-text">A validating SQL lexer and parser with a
65 |                             focus on MySQL dialect
66 |                         </p>
67 |                     </div>
68 |                     <div class="card-footer text-center"><a href="/sql-parser/" class="card-link">Documentation</a>
69 |                     </div>
70 |                 </div>
71 |                 <div class="card">
72 |                     <div class="card-body">
73 |                         <h5 class="card-title">simple-math</h5>
74 |                         <p class="card-text">Simple math evaluator</p>
75 |                     </div>
76 |                     <div class="card-footer text-center"><a href="/simple-math/" class="card-link">Documentation</a>
77 |                     </div>
78 |                 </div>
79 |                 <div class="col-1">&nbsp;</div>
80 |             </div>
81 |         </div>
82 |     </main>
83 | </body>
84 | 
85 | </html>


--------------------------------------------------------------------------------
/demo/php/config-common.inc.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * Generated configuration file
 4 |  * Generated by: phpMyAdmin 2.9.0-dev setup script by Michal Čihař <michal@cihar.com>
 5 |  * Version: $Id: setup.php,v 1.29 2006/03/17 10:17:58 nijel Exp $
 6 |  * Date: Thu, 27 Apr 2006 13:37:57 GMT
 7 |  */
 8 | 
 9 | /* Servers configuration */
10 | $i = 0;
11 | 
12 | /* Server localhost (config:root) [1] */
13 | $i++;
14 | $cfg['Servers'][$i]['bookmarktable'] = 'pma__bookmark';
15 | $cfg['Servers'][$i]['relation'] = 'pma__relation';
16 | $cfg['Servers'][$i]['table_info'] = 'pma__table_info';
17 | $cfg['Servers'][$i]['table_coords'] = 'pma__table_coords';
18 | $cfg['Servers'][$i]['pdf_pages'] = 'pma__pdf_pages';
19 | $cfg['Servers'][$i]['column_info'] = 'pma__column_info';
20 | $cfg['Servers'][$i]['history'] = 'pma__history';
21 | $cfg['Servers'][$i]['tracking'] = 'pma__tracking';
22 | $cfg['Servers'][$i]['designer_coords'] = 'pma__designer_coords';
23 | // $cfg['Servers'][$i]['userconfig'] = 'pma__userconfig';
24 | $cfg['Servers'][$i]['recent'] = 'pma__recent';
25 | $cfg['Servers'][$i]['favorite'] = 'pma__favorite';
26 | $cfg['Servers'][$i]['users'] = 'pma__users';
27 | $cfg['Servers'][$i]['usergroups'] = 'pma__usergroups';
28 | $cfg['Servers'][$i]['navigationhiding'] = 'pma__navigationhiding';
29 | $cfg['Servers'][$i]['savedsearches'] = 'pma__savedsearches';
30 | $cfg['Servers'][$i]['central_columns'] = 'pma__central_columns';
31 | $cfg['Servers'][$i]['designer_settings'] = 'pma__designer_settings';
32 | $cfg['Servers'][$i]['export_templates'] = 'pma__export_templates';
33 | $cfg['Servers'][$i]['host'] = '192.168.30.22';
34 | $cfg['Servers'][$i]['extension'] = 'mysqli';
35 | $cfg['Servers'][$i]['connect_type'] = 'tcp';
36 | $cfg['Servers'][$i]['compress'] = false;
37 | $cfg['Servers'][$i]['controluser'] = 'pma';
38 | $cfg['Servers'][$i]['controlpass'] = 'heslo';
39 | $cfg['Servers'][$i]['auth_type'] = 'cookie';
40 | $cfg['Servers'][$i]['user'] = 'root';
41 | $cfg['Servers'][$i]['AllowNoPassword'] = true;
42 | $cfg['Servers'][$i]['pmadb'] = 'phpmyadmin';
43 | $cfg['Servers'][$i]['verbose'] = 'phpMyAdmin demo - MariaDB';
44 | 
45 | /* Server localhost (config:root) [2] */
46 | $i++;
47 | $cfg['Servers'][$i]['bookmarktable'] = 'pma__bookmark';
48 | $cfg['Servers'][$i]['relation'] = 'pma__relation';
49 | $cfg['Servers'][$i]['table_info'] = 'pma__table_info';
50 | $cfg['Servers'][$i]['table_coords'] = 'pma__table_coords';
51 | $cfg['Servers'][$i]['pdf_pages'] = 'pma__pdf_pages';
52 | $cfg['Servers'][$i]['column_info'] = 'pma__column_info';
53 | $cfg['Servers'][$i]['history'] = 'pma__history';
54 | $cfg['Servers'][$i]['table_uiprefs'] = 'pma__table_uiprefs';
55 | $cfg['Servers'][$i]['tracking'] = 'pma__tracking';
56 | $cfg['Servers'][$i]['designer_coords'] = 'pma__designer_coords';
57 | // $cfg['Servers'][$i]['userconfig'] = 'pma__userconfig';
58 | $cfg['Servers'][$i]['recent'] = 'pma__recent';
59 | $cfg['Servers'][$i]['favorite'] = 'pma__favorite';
60 | $cfg['Servers'][$i]['users'] = 'pma__users';
61 | $cfg['Servers'][$i]['usergroups'] = 'pma__usergroups';
62 | $cfg['Servers'][$i]['navigationhiding'] = 'pma__navigationhiding';
63 | $cfg['Servers'][$i]['savedsearches'] = 'pma__savedsearches';
64 | $cfg['Servers'][$i]['central_columns'] = 'pma__central_columns';
65 | $cfg['Servers'][$i]['designer_settings'] = 'pma__designer_settings';
66 | $cfg['Servers'][$i]['export_templates'] = 'pma__export_templates';
67 | $cfg['Servers'][$i]['host'] = '192.168.30.23';
68 | $cfg['Servers'][$i]['extension'] = 'mysqli';
69 | $cfg['Servers'][$i]['connect_type'] = 'tcp';
70 | $cfg['Servers'][$i]['compress'] = false;
71 | $cfg['Servers'][$i]['controluser'] = 'pma';
72 | $cfg['Servers'][$i]['controlpass'] = 'heslo';
73 | $cfg['Servers'][$i]['auth_type'] = 'cookie';
74 | $cfg['Servers'][$i]['user'] = 'root';
75 | $cfg['Servers'][$i]['AllowNoPassword'] = true;
76 | $cfg['Servers'][$i]['pmadb'] = 'phpmyadmin';
77 | $cfg['Servers'][$i]['verbose'] = 'phpMyAdmin demo - MySQL';
78 | 
79 | /* End of servers configuration */
80 | 
81 | // Random generated string (should be 32 bytes long)
82 | $cfg['blowfish_secret'] = 'nH5&L56HLDFbsgHHpP$HChD8hop@4xHn';
83 | 
84 | $cfg['Error_Handler']['display'] = true;
85 | $cfg['Error_Handler']['gather'] = false;
86 | 
87 | $cfg['SuhosinDisableWarning'] = true;
88 | $cfg['PmaNoRelation_DisableWarning'] = true;
89 | $cfg['TranslationWarningThreshold'] = 95;
90 | $cfg['ServerDefault'] = 2;
91 | $cfg['CSPAllow'] = 'www.google-analytics.com ssl.google-analytics.com';
92 | // $cfg['MaxDbList'] = 3;
93 | $cfg['DBG']['demo'] = true;
94 | 


--------------------------------------------------------------------------------
/hooks/commits.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * GitHub webhook to check Signed-Off-By in pull request commits.
  5 |  */
  6 | 
  7 | error_reporting(E_ALL);
  8 | 
  9 | define('PMAHOOKS', true);
 10 | 
 11 | require_once __DIR__ . '/lib/github.php';
 12 | 
 13 | github_verify_post();
 14 | 
 15 | $contributing_url = 'https://github.com/phpmyadmin/phpmyadmin/blob/master/CONTRIBUTING.md';
 16 | $guidelines_url = 'https://github.com/phpmyadmin/phpmyadmin/wiki/Developer_guidelines';
 17 | $dcoLink = 'https://github.com/phpmyadmin/phpmyadmin/blob/master/DCO';
 18 | 
 19 | $message_sob = "<!-- PMABOT:SOB -->\n"
 20 |     . 'This commit is missing Signed-Off-By line to indicate '
 21 |     . "that you agree with phpMyAdmin Developer's Certificate of Origin. "
 22 |     . 'Please check [contributing documentation]('
 23 |     . $contributing_url
 24 |     . ') for more information.';
 25 | 
 26 | $message_sob_invalid = "<!-- PMABOT:SOB --><!-- PMABOT:SOB:INVALID -->\n"
 27 |     . 'This commit has an invalid Signed-Off-By line, please use '
 28 |     . "your full name for legal compliance reasons.\n"
 29 |     . 'Please check [Developer\'s Certificate of Origin](' . $dcoLink . ")\n"
 30 |     . 'Here is a valid example: `Signed-off-by: Jane Smith <jane.smith@example.org>`';
 31 | 
 32 | $message_tab = "<!-- PMABOT:TAB -->\n"
 33 |     . 'This commit is using tab character for indentation instead '
 34 |     . 'of spaces, what is mandated by phpMyAdmin. Please check our '
 35 |     . '[Developer guidelines]('
 36 |     . $guidelines_url
 37 |     . '#Indentation) for more information.'
 38 |     . "\n\nOffending files: ";
 39 | 
 40 | $message_space = "<!-- PMABOT:SPACE -->\n"
 41 |     . 'This commit contains trailing whitespace, '
 42 |     . 'what is prohibited in phpMyAdmin. Please check our '
 43 |     . '[Developer guidelines]('
 44 |     . $guidelines_url
 45 |     . '#Indentation) for more information.'
 46 |     . "\n\nOffending files: ";
 47 | 
 48 | $message_eol = "<!-- PMABOT:EOL -->\n"
 49 |     . 'This commit is using DOS end of line characters instead '
 50 |     . 'of UNIX ones, what is mandated by phpMyAdmin. Please check our '
 51 |     . '[Developer guidelines]('
 52 |     . $guidelines_url
 53 |     . '#Indentation) for more information.'
 54 |     . "\n\nOffending files: ";
 55 | 
 56 | $message_commits = "<!-- PMABOT:COMMITS -->\n"
 57 |     . 'This pull requests contains too many commits, in most cases '
 58 |     . 'it is caused by wrong merge target. In case you have forked '
 59 |     . '`master` branch you should also ask merging to `master` branch. '
 60 |     . 'See [GitHub documentation]'
 61 |     . '(https://help.github.com/articles/creating-a-pull-request/) '
 62 |     . 'for more details.';
 63 | 
 64 | /* Parse JSON */
 65 | $data = json_decode($_POST['payload'], true);
 66 | 
 67 | /* Check request data */
 68 | if (isset($data['zen']) && isset($data['hook']) && isset($data['hook_id'])) {
 69 |     json_response(['pong' => true]);
 70 |     die;
 71 | }
 72 | 
 73 | if (! isset($data['pull_request']) || ! isset($data['action'])) {
 74 |     fail('No pull request data!');
 75 | }
 76 | 
 77 | /* We don't care about closed requests */
 78 | if ($data['action'] == 'closed') {
 79 |     die;
 80 | }
 81 | 
 82 | /* Check number of commits */
 83 | if ($data['pull_request']['commits'] > 50) {
 84 |     github_comment_pull($data['repository']['full_name'], $data['pull_request']['number'], $message_commits);
 85 |     die;
 86 | }
 87 | 
 88 | /* Parse repository name */
 89 | $repo_name = $data['pull_request']['head']['repo']['full_name'];
 90 | 
 91 | /* List commits in the pull request */
 92 | $commits = github_pull_commits($data['repository']['full_name'], $data['pull_request']['number']);
 93 | 
 94 | $comments = [];
 95 | 
 96 | /* Process commits in the pull request */
 97 | foreach ($commits as $commit) {
 98 |     /* Ignore merge commits */
 99 |     if (count($commit['parents']) > 1) {
100 |         continue;
101 |     }
102 | 
103 |     /* Fetch current comments */
104 |     $current_comments = github_commit_comments($repo_name, $commit['sha']);
105 |     $comments_text = '';
106 |     foreach ($current_comments as $comment) {
107 |         $comments_text .= $comment['body'];
108 |     }
109 | 
110 |     /* Check for missing SOB */
111 |     if (! preg_match("@\nSigned-off-by:@i", $commit['commit']['message'])) {
112 |         if (strpos($comments_text, '<!-- PMABOT:SOB -->') === false) {
113 |             github_comment_commit($repo_name, $commit['sha'], $message_sob);
114 |             $comments[] = [
115 |                 'type' => 'SOB',
116 |                 'commit' => $commit['sha'],
117 |                 'message' => $commit['commit']['message'],
118 |             ];
119 |         }
120 |     } else {
121 |         /* Check for invalid SOB */
122 |         if (! preg_match("@\nSigned-off-by: +(?:[\p{L}\-\.]+\s){2,}<.*>@iu", $commit['commit']['message'])) {
123 |             if (strpos($comments_text, '<!-- PMABOT:SOB:INVALID -->') === false) {
124 |                 github_comment_commit($repo_name, $commit['sha'], $message_sob_invalid);
125 |                 $comments[] = [
126 |                     'type' => 'SOB',
127 |                     'commit' => $commit['sha'],
128 |                     'message' => $commit['commit']['message'],
129 |                 ];
130 |             }
131 |         }
132 |     }
133 | 
134 |     /* Check for tab or trailing whitespace in diff */
135 |     $detail = github_commit_detail($data['repository']['full_name'], $commit['sha']);
136 |     $files_tab = [];
137 |     $files_space = [];
138 |     $files_eol = [];
139 |     foreach ($detail['files'] as $file) {
140 |         if (preg_match("@\n\+[^\n]*\t@", $file['patch'])) {
141 |             $matchAdvisory = preg_match('/^libraries\/advisory_rules.*\.txt$/', $file['filename']);
142 |             // Example: https://api.github.com/repos/phpmyadmin/phpmyadmin/commits/b7cb1c84bacc5de1490a4e5cf241401cbfa5c105
143 |             $isABaseLineFile = in_array($file['filename'], [
144 |                 'phpstan-baseline.neon',
145 |                 'psalm-baseline.xml',
146 |             ]);
147 |             if (! $matchAdvisory && ! $isABaseLineFile) {
148 |                 $files_tab[] = $file['filename'];
149 |             }
150 |         }
151 |         if (preg_match("@\n\+[^\n]* \n@", $file['patch'])) {
152 |             $files_space[] = $file['filename'];
153 |         }
154 |         if (! preg_match("@\n\+[^\n]*\r@", $file['patch'])) {
155 |             continue;
156 |         }
157 | 
158 |         $files_eol[] = $file['filename'];
159 |     }
160 |     if (count($files_tab) && strpos($comments_text, 'PMABOT:TAB') === false) {
161 |         github_comment_commit($repo_name, $commit['sha'], $message_tab . implode(', ', $files_tab));
162 |         $comments[] = [
163 |             'type' => 'TAB',
164 |             'commit' => $commit['sha'],
165 |             'message' => $commit['commit']['message'],
166 |         ];
167 |     }
168 |     if (count($files_space) && strpos($comments_text, 'PMABOT:SPACE') === false) {
169 |         github_comment_commit($repo_name, $commit['sha'], $message_space . implode(', ', $files_space));
170 |         $comments[] = [
171 |             'type' => 'SPACE',
172 |             'commit' => $commit['sha'],
173 |             'message' => $commit['commit']['message'],
174 |         ];
175 |     }
176 |     if (! count($files_eol) || strpos($comments_text, 'PMABOT:EOL') !== false) {
177 |         continue;
178 |     }
179 | 
180 |     github_comment_commit($repo_name, $commit['sha'], $message_eol . implode(', ', $files_eol));
181 |     $comments[] = [
182 |         'type' => 'EOL',
183 |         'commit' => $commit['sha'],
184 |         'message' => $commit['commit']['message'],
185 |     ];
186 | }
187 | 
188 | json_response(['comments' => $comments]);
189 | 


--------------------------------------------------------------------------------
/phpmyadmin-reports:
--------------------------------------------------------------------------------
  1 | #! /usr/bin/env python3
  2 | # -*- coding: utf-8 -*-
  3 | """
  4 | phpMyAdmin work reporting tool
  5 | 
  6 | Generates list of commits and issues handled in given period.
  7 | 
  8 | Copyright © 2016 Michal Čihař <michal@cihar.com>
  9 | 
 10 | Requirements:
 11 | 
 12 | * Python 3
 13 | * PyGithub
 14 | * python-dateutil
 15 | """
 16 | 
 17 | from configparser import RawConfigParser, NoOptionError, NoSectionError
 18 | import os
 19 | import sys
 20 | from datetime import datetime, timedelta, timezone
 21 | from argparse import ArgumentParser, RawDescriptionHelpFormatter
 22 | import dateutil.parser
 23 | try:
 24 |     from github import Github
 25 | except ImportError:
 26 |     print('PyGithub is required, please install it')
 27 |     print(' * using pip: pip3 install PyGithub')
 28 |     print(' * using apt: apt install python3-github')
 29 |     sys.exit(1)
 30 | 
 31 | # Settings
 32 | 
 33 | # List of projects to report
 34 | PROJECTS = (
 35 |     'phpmyadmin/phpmyadmin',
 36 |     'phpmyadmin/phpmyadmin-security',
 37 |     'phpmyadmin/docker',
 38 |     'phpmyadmin/website',
 39 |     'phpmyadmin/sql-parser',
 40 |     'phpmyadmin/motranslator',
 41 |     'phpmyadmin/private',
 42 |     'phpmyadmin/shapefile',
 43 |     'phpmyadmin/simple-math',
 44 |     'phpmyadmin/localized_docs',
 45 |     'phpmyadmin/error-reporting-server',
 46 |     'phpmyadmin/twig-i18n-extension',
 47 |     'phpmyadmin/coding-standard',
 48 |     'phpmyadmin/scripts',
 49 | )
 50 | # Only include commits not present elsewhere from this repository
 51 | PROJECT_EXTRA_COMMITS = (
 52 |     'phpmyadmin/phpmyadmin-security',
 53 | )
 54 | # Private repositories not to list in weekly reports
 55 | PRIVATE = (
 56 |     'phpmyadmin/phpmyadmin-security',
 57 |     'phpmyadmin/private',
 58 | )
 59 | 
 60 | # Markdown esp
 61 | MARDOWN_TRANS = str.maketrans({
 62 |     "[":  r"\[",
 63 |     "]":  r"\]",
 64 |     "\\": r"\\",
 65 |     '>': r'\>',
 66 | })
 67 | 
 68 | 
 69 | def get_parser():
 70 |     """Create command line argument parser."""
 71 |     parser = ArgumentParser(
 72 |         description='phpMyAdmin work reporting tool\n\nGenerates list of commits and issues handled in given period.',
 73 |         epilog='Credentials can be also stored in ~/.config/phpmyadmin:\n\n[github]\nuser=USER\ntoken=TOKEN',
 74 |         formatter_class=RawDescriptionHelpFormatter,
 75 |     )
 76 |     parser.add_argument(
 77 |         '-u', '--user',
 78 |         help='GitHub username, used for both reporting and authentication'
 79 |     )
 80 |     parser.add_argument(
 81 |         '-t', '--token',
 82 |         help='GitHub authentication token'
 83 |     )
 84 |     parser.add_argument(
 85 |         '-s', '--start-date',
 86 |         type=dateutil.parser.parse,
 87 |         default=datetime.now() - timedelta(days=7),
 88 |         help='Starting datetime, defaults to 7 days ago'
 89 |     )
 90 |     parser.add_argument(
 91 |         '-e', '--end-date',
 92 |         type=dateutil.parser.parse,
 93 |         default=datetime.now(),
 94 |         help='Ending datetime, defaults to current timestamp'
 95 |     )
 96 |     parser.add_argument(
 97 |         '-f', '--format',
 98 |         choices=('markdown', ),
 99 |         default='markdown',
100 |         help='Output format',
101 |     )
102 |     parser.add_argument(
103 |         '-w', '--weekly',
104 |         action='store_true',
105 |         help='Weekly report not including private repositories'
106 |     )
107 |     parser.add_argument(
108 |         '-W', '--last-week',
109 |         action='store_true',
110 |         help='Create report for last week'
111 |     )
112 |     parser.add_argument(
113 |         '-M', '--last-month',
114 |         action='store_true',
115 |         help='Create report for last month'
116 |     )
117 |     parser.add_argument(
118 |         '--this-week',
119 |         action='store_true',
120 |         help='Create report for this week'
121 |     )
122 |     return parser
123 | 
124 | 
125 | def get_repo_data(gh, user, name, start, end):
126 |     """Get data for single repository"""
127 |     repo = gh.get_repo(name)
128 | 
129 |     commits = []
130 |     issues = []
131 | 
132 |     all_commits = repo.get_commits(author=user, since=start, until=end)
133 |     for commit in all_commits:
134 |         # skip merge commits
135 |         if len(commit.parents) == 1:
136 |             commits.append(commit)
137 | 
138 |     all_issues = repo.get_issues(
139 |         assignee=user, state='closed', sort='updated', direction='desc'
140 |     )
141 |     for issue in all_issues:
142 |         if issue.updated_at < start:
143 |             break
144 |         if issue.closed_at > end:
145 |             continue
146 |         if issue.closed_at < start:
147 |             continue
148 |         issues.append(issue)
149 | 
150 |     return issues, commits
151 | 
152 | 
153 | def get_data(user, token, start, end, weekly):
154 |     """Retrieves data from github"""
155 |     gh = Github(user, token)
156 | 
157 |     issues = []
158 |     commits = []
159 |     commit_set = set()
160 | 
161 |     for project in PROJECTS:
162 |         if weekly and project in PRIVATE:
163 |             continue
164 |         issues_new, commits_new = get_repo_data(gh, user, project, start, end)
165 |         # Include all issues
166 |         issues.extend(issues_new)
167 | 
168 |         if project in PROJECT_EXTRA_COMMITS:
169 |             # Only include commits not seen so far from this repo
170 |             for commit in commits_new:
171 |                 sha = commit.sha[:7]
172 |                 if sha not in commit_set:
173 |                     commits.append(commit)
174 |                     commit_set.add(sha)
175 |         else:
176 |             # Include all commits
177 |             commits.extend(commits_new)
178 |             commit_set.update([commit.sha[:7] for commit in commits_new])
179 | 
180 |     return issues, commits
181 | 
182 | 
183 | def markdown_escape(text):
184 |     """Escapes string to be used in markdown link"""
185 |     return text.translate(MARDOWN_TRANS)
186 | 
187 | 
188 | def markdown_item(title, url):
189 |     """Displays single markdown item"""
190 |     print('* [{0}]({1})'.format(
191 |         markdown_escape(title),
192 |         markdown_escape(url),
193 |     ))
194 | 
195 | 
196 | def markdown_report(issues, commits):
197 |     """Displays report in markdown"""
198 |     print()
199 |     print('Handled issues:')
200 |     print()
201 | 
202 |     for issue in issues:
203 |         markdown_item(
204 |             '#{0} {1}'.format(
205 |                 issue.number,
206 |                 issue.title,
207 |             ),
208 |             issue.html_url,
209 |         )
210 | 
211 |     print()
212 |     print('Commits:')
213 |     print()
214 | 
215 |     for commit in commits:
216 |         markdown_item(
217 |             '{0} - {1}'.format(
218 |                 commit.sha[:7],
219 |                 commit.commit.message.split('\n')[0]
220 |             ),
221 |             commit.html_url,
222 |         )
223 | 
224 | 
225 | def merge_config(user, token):
226 |     """Merges user configuration if no credentials on commandline"""
227 |     if user is not None and token is not None:
228 |         return (user, token)
229 | 
230 |     config = RawConfigParser()
231 |     config.read(os.path.expanduser('~/.config/phpmyadmin'))
232 | 
233 |     try:
234 |         if user is None:
235 |             user = config.get('github', 'user')
236 |         if token is None:
237 |             token = config.get('github', 'token')
238 |     except (NoSectionError, NoOptionError):
239 |         print('Missing GitHub credentials!')
240 |         print('Please provide them on command line or in ~/.config/phpmyadmin')
241 |         sys.exit(1)
242 | 
243 |     return user, token
244 | 
245 | 
246 | def main(params):
247 |     """Main program"""
248 |     parser = get_parser()
249 | 
250 |     args = parser.parse_args(params)
251 | 
252 |     user, token = merge_config(args.user, args.token)
253 | 
254 |     if args.last_week or args.this_week:
255 |         weekly = True
256 |         end = datetime.now()
257 |         end -= timedelta(days=1 + end.weekday())
258 |         if args.this_week:
259 |             end += timedelta(days=7)
260 |         start = end - timedelta(days=6)
261 |     elif args.last_month:
262 |         end = datetime.now().replace(day=1) - timedelta(days=1)
263 |         start = end.replace(day=1)
264 |         weekly = False
265 |     else:
266 |         start = args.start_date
267 |         end = args.end_date
268 |         weekly = args.weekly
269 | 
270 |     start = datetime(start.year, start.month, start.day, tzinfo=timezone.utc)
271 |     end = datetime(end.year, end.month, end.day, 23, 59, 59, tzinfo=timezone.utc)
272 | 
273 |     issues, commits = get_data(user, token, start, end, weekly)
274 | 
275 |     if args.format == 'markdown':
276 |         markdown_report(issues, commits)
277 | 
278 | 
279 | if __name__ == '__main__':
280 |     main(sys.argv[1:])
281 | 


--------------------------------------------------------------------------------
/website/daily-composer:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | # Daily executed script to push changes to Packgagist
  3 | #  - updates all maintained branches
  4 | #  - updates all tags
  5 | #  - generates README to describe that this is generated repo
  6 | 
  7 | # Fail on error or undefined variable
  8 | set -e
  9 | set -u
 10 | 
 11 | if [ -z "${1:-}" ] || [ ! -d "${1:-}" ]; then
 12 |     echo "Usage daily-composer ~/composer"
 13 |     echo "Usage daily-composer ~/composer --force"
 14 |     exit 1
 15 | fi
 16 | 
 17 | # Working directory
 18 | DIR="${1}"
 19 | 
 20 | # Branches we process
 21 | BRANCHES="QA_5_2 QA_4_9 master"
 22 | 
 23 | generate_readme() {
 24 |     cat > README.rst <<EOT
 25 | phpMyAdmin for Composer
 26 | =======================
 27 | 
 28 | This is automatically generated repository to allow installation of phpMyAdmin
 29 | using composer.
 30 | 
 31 | You can find phpMyAdmin repository here:
 32 | 
 33 | https://github.com/phpmyadmin/phpmyadmin/
 34 | 
 35 | This repository is updated daily.
 36 | EOT
 37 |     if ! git diff --quiet -- README.rst ; then
 38 |         git commit -m 'Updated README' README.rst
 39 |     fi
 40 | }
 41 | 
 42 | generate_mo() {
 43 |     # TODO: This can be cleaned up and removed when no release exists with ./scripts/
 44 |     if [ -f ./scripts/generate-mo ]; then
 45 |       rm -rf locale
 46 |       ./scripts/generate-mo
 47 |       git add -f locale
 48 |     else
 49 |       rm -rf resources/locale
 50 |       ./bin/generate-mo
 51 |       git add -f resources/locale
 52 |     fi
 53 |     if ! git diff --quiet --cached ; then
 54 |         git commit -m 'Update mo files'
 55 |     fi
 56 | }
 57 | 
 58 | generate_css() {
 59 |     # You can not use --production because it creates the error "[BABEL]: Cannot find module 'browserslist'"
 60 |     yarn install --frozen-lockfile --non-interactive --silent
 61 |     if [ -f ./bin/console ]; then
 62 |         git add --force public/themes/*/css/*.css || echo "No css file found, not adding to git repository"
 63 |         git add --force public/themes/*/css/*.css.map || echo "No css.map files found, not adding to git repository"
 64 |         git add --force public/setup/*.css || echo "No css.map files found, not adding to git repository"
 65 |         git add --force public/setup/*.css.map || echo "No css.map files found, not adding to git repository"
 66 |     else
 67 |         git add --force themes/*/css/*.css || echo "No css file found, not adding to git repository"
 68 |         git add --force themes/*/css/*.css.map || echo "No css.map files found, not adding to git repository"
 69 |         git add --force setup/*.css || echo "No css.map files found, not adding to git repository"
 70 |         git add --force setup/*.css.map || echo "No css.map files found, not adding to git repository"
 71 |     fi
 72 |     if ! git diff --quiet --cached ; then
 73 |         git commit -m 'Update generated CSS files'
 74 |     fi
 75 | }
 76 | 
 77 | generate_js() {
 78 |     # You can not use --production because it creates the error "[BABEL]: Cannot find module 'browserslist'"
 79 |     yarn install --frozen-lockfile --non-interactive --silent
 80 |     if [ -f ./bin/console ]; then
 81 |         git add --force public/js/ || echo "No JS files found, not adding to git repository"
 82 |     else
 83 |         git add --force js/dist/ || echo "No JS files found, not adding to git repository"
 84 |     fi
 85 |     if ! git diff --quiet --cached ; then
 86 |         git commit -m 'Update generated JS files'
 87 |     fi
 88 | }
 89 | 
 90 | # Keep in sync with phpmyadmin/phpmyadmin:scripts/create-release.sh
 91 | fetchReleaseFromFile() {
 92 |     php -r "define('VERSION_SUFFIX', ''); require_once('libraries/classes/Version.php'); echo \PhpMyAdmin\Version::VERSION;"
 93 | }
 94 | 
 95 | set_version_in_composer() {
 96 |     if [ ! -f libraries/classes/Version.php ]; then
 97 |         echo "The version file does not exist for this version"
 98 |         return
 99 |     fi
100 | 
101 |     # The reason the version is added to the composer.json file is because of:
102 |     # - https://github.com/phpmyadmin/phpmyadmin/issues/17570
103 |     # - https://github.com/Roave/SecurityAdvisories/issues/76
104 | 
105 |     echo "Detected version: $(fetchReleaseFromFile)"
106 |     composer config version "$(fetchReleaseFromFile)"
107 |     echo "Saved version: $(composer config version)"
108 |     git add composer.json
109 |     if ! git diff --quiet --cached ; then
110 |         git commit -m 'Set version in composer.json' -m "Version: $(composer config version)"
111 |     fi
112 | }
113 | 
114 | reset_not_allowed_to_change_source_files() {
115 |     # Source: https://stackoverflow.com/a/68019875/5155484
116 | 
117 |     if [ -f yarn-error.log ]; then
118 |         rm -v yarn-error.log
119 |     fi
120 | 
121 |     # Source: https://stackoverflow.com/a/2196755/5155484
122 |     echo "Cleaning ignored files"
123 |     git clean -fdX
124 | 
125 |     if [ -f ./bin/console ]; then
126 |         CHANGED_FILES="$(git diff phpmyadmin/$branch..$newbranch --name-only -- './*' ':!README.rst' ':!public/js/vendor/**' ':!public/js/*.js' ':!public/js/*.js.map' ':!resources/locale/*.mo' ':!public/themes/*.css' ':!public/themes/*.css.map' ':!public/setup/*.css' ':!public/setup/*.css.map')"
127 |     else
128 |         CHANGED_FILES="$(git diff phpmyadmin/$branch..$newbranch --name-only -- './*' ':!README.rst' ':!js/dist/*.js' ':!js/dist/*.js.map' ':!locale/*.mo' ':!themes/*.css' ':!themes/*.css.map' ':!setup/*.css' ':!setup/*.css.map')"
129 |     fi
130 | 
131 |     if [ -z "$CHANGED_FILES" ]; then
132 |         echo "No files did change"
133 |         return
134 |     fi
135 | 
136 |     echo "Files changed: $CHANGED_FILES"
137 | 
138 |     echo "$CHANGED_FILES" | xargs git checkout phpmyadmin/$branch --theirs
139 |     echo "$CHANGED_FILES" | xargs git add --force
140 |     unset CHANGED_FILES
141 | 
142 |     if ! git diff --quiet --cached ; then
143 |         git commit -m 'Reset changed source files'
144 |     fi
145 | }
146 | 
147 | # Ensure we have working dir
148 | if [ ! -d "$DIR" ] ; then
149 |     git clone git@github.com:phpmyadmin/composer.git "$DIR"
150 |     cd "$DIR"
151 |     git remote add --no-tags phpmyadmin https://github.com/phpmyadmin/phpmyadmin.git
152 | else
153 |     cd "$DIR"
154 | fi
155 | 
156 | # Update phpmyadmin remote
157 | git remote update phpmyadmin
158 | # Fetch tags (we don't want them as tags)
159 | git fetch phpmyadmin '+refs/tags/*:refs/remotes/phpmyadmin/tags/*'
160 | 
161 | # Destroy local changes
162 | git reset --hard
163 | 
164 | # Disable renames detection (it breaks merges)
165 | git config merge.renames false
166 | 
167 | # Process branches
168 | for branch in $BRANCHES ; do
169 |     if [ $branch = master ] ; then
170 |         newbranch=master
171 |     else
172 |         newbranch=`echo $branch | sed -e 's/QA_//' -e 's/_/./g' `.x
173 |     fi
174 |     echo "Working on $newbranch ($branch)"
175 | 
176 |     # Ensure we have the branch
177 |     if git rev-parse --verify --quiet $newbranch ; then
178 |         git checkout $newbranch
179 |         if [ `git log --oneline ..phpmyadmin/$branch | wc -l` -eq 0 ] ; then
180 |             if [ -z "${2:-}" ] || [ "${2:-}" != "--force" ]; then
181 |                 echo "No changes for $newbranch ($branch)"
182 |                 continue
183 |             fi
184 |         fi
185 |         git merge --no-edit --strategy=recursive --strategy-option=theirs phpmyadmin/$branch
186 |     else
187 |         git checkout -b $newbranch phpmyadmin/$branch
188 |     fi
189 | 
190 |     # Destroy any possible changes
191 |     git reset --hard
192 |     # Force an update just in case
193 |     git pull --ff --rebase=false
194 | 
195 |     # Reset content that could have changed by mistake
196 |     reset_not_allowed_to_change_source_files
197 | 
198 |     # Update content
199 |     generate_readme
200 |     generate_mo
201 |     generate_css
202 |     generate_js
203 |     set_version_in_composer
204 | 
205 |     # Display ignored files
206 |     git status --ignored
207 | 
208 |     # Push
209 |     git push origin $newbranch
210 | done
211 | 
212 | # Process tags
213 | 
214 | # We don't take tags prior to 4.7.0, since that's when we started distributing through Composer.
215 | # This grep string matches 4.7-9 or anything higher than 5.
216 | # We also do not match on any release candidate or development release.
217 | for tag in $(git branch -r | grep 'phpmyadmin/tags/\(RELEASE_[4]_[7-9]_[0-9]\+\(_[0-9]\)\?$\)\|\(RELEASE_\([^1-4]\|[0-9]\{2,\}\)\_[0-9]\+_[0-9]\+\(_[0-9]\)\?$\)') ; do
218 |     newtag=`echo $tag | sed -e 's@.*RELEASE_@@' -e 's/_/./g'`
219 |     if git rev-parse --verify --quiet $newtag ; then
220 |         continue
221 |     fi
222 |     echo "Working on $newtag ($tag)"
223 | 
224 |     # Create temporary branch
225 |     git checkout -b tmp $tag
226 | 
227 |     # Update content
228 |     generate_readme
229 |     generate_mo
230 |     generate_css
231 |     generate_js
232 |     set_version_in_composer
233 | 
234 |     # Display ignored files
235 |     git status --ignored
236 | 
237 |     # Create tag
238 |     git tag -a -m "Composer tag for $tag" $newtag
239 | 
240 |     # Remove temporary branch
241 |     git checkout master
242 |     git branch -D tmp
243 | 
244 |     # Push the tag
245 |     git push origin $newtag
246 | done
247 | 


--------------------------------------------------------------------------------
/hooks/lib/github.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * GitHub operations layer.
  4 |  */
  5 | 
  6 | if (! defined('PMAHOOKS')) {
  7 |     fail('Invalid invocation!');
  8 | }
  9 | 
 10 | require_once __DIR__ . '/../config.php';
 11 | 
 12 | $curlBaseOpts = [
 13 |     CURLOPT_USERAGENT => 'phpMyAdmin-bot',
 14 |     CURLOPT_RETURNTRANSFER => 1,
 15 |     CURLOPT_HTTPHEADER => [
 16 |         'Content-Type: application/json',
 17 |         'Authorization: token ' . GITHUB_TOKEN,
 18 | 
 19 |     ],
 20 | ];
 21 | 
 22 | /**
 23 |  * Builds the body of the email to send
 24 |  *
 25 |  * @see https://developer.github.com/v3/activity/events/types/#pushevent
 26 |  *
 27 |  * @param stdClass $inputData The JSON payload
 28 |  *
 29 |  * @return stdClass {
 30 |  *       "repoName": "org/repo",
 31 |  *       "compare": "URL TO COMPARE PAGE",
 32 |  *       "emailBody": "THE RAW BODY",
 33 |  *       "headCommitTitle": "commit title",
 34 |  *       "headCommitShortHash": "abcde",
 35 |  *       "authorName": "William Desportes",
 36 |  *       "authorEmail": "williamdes@wdes.fr"
 37 |  * }
 38 |  */
 39 | function github_webhook_push(stdClass $inputData): stdClass
 40 | {
 41 |     $msg  = '';
 42 |     $msg .= 'Branch: ' . $inputData->ref . PHP_EOL;
 43 |     $msg .= 'Home: ' . $inputData->repository->html_url . PHP_EOL;
 44 | 
 45 |     foreach ($inputData->commits as $commit) {
 46 |         $msg .= 'Commit: ' . $commit->id . PHP_EOL;
 47 |         $msg .= $commit->url . PHP_EOL;
 48 |         $msg .= 'Author: ' . $commit->author->name . ' <' . $commit->author->email . '>' . PHP_EOL;
 49 | 
 50 |         $date = new DateTime($commit->timestamp);
 51 |         $msg .= 'Date: ' . $date->format('Y-m-d (D, m F Y) P') . PHP_EOL . PHP_EOL;
 52 | 
 53 |         $msg .= 'Changed paths: ' . PHP_EOL;
 54 |         foreach ($commit->added as $file) {
 55 |             $msg .= 'A ' . $file . PHP_EOL;
 56 |         }
 57 |         foreach ($commit->modified as $file) {
 58 |             $msg .= 'M ' . $file . PHP_EOL;
 59 |         }
 60 |         foreach ($commit->removed as $file) {
 61 |             $msg .= 'D ' . $file . PHP_EOL;
 62 |         }
 63 |         $msg .= PHP_EOL . 'Log Message:' . PHP_EOL . '-----------' . PHP_EOL;
 64 |         $msg .= $commit->message . PHP_EOL . PHP_EOL;
 65 |     }
 66 | 
 67 |     $data = new stdClass();
 68 |     $data->repoName            = $inputData->repository->full_name;
 69 |     $data->compare             = $inputData->compare;
 70 |     $data->emailBody           = $msg;
 71 |     // Commits can be empty and head_commit filled in case of a tag
 72 |     $firstCommit = $inputData->commits[0] ?? $inputData->head_commit;
 73 |     $data->headCommitTitle     = explode("\n", $firstCommit->message)[0];
 74 |     $data->headCommitShortHash = substr($firstCommit->id, 0, 6);
 75 |     $data->authorName          = $firstCommit->author->name;
 76 |     $data->authorEmail         = $firstCommit->author->email;
 77 | 
 78 |     return $data;
 79 | }
 80 | 
 81 | /**
 82 |  * Verifies signature from GitHub
 83 |  */
 84 | function github_verify_post()
 85 | {
 86 |     if (empty(GITHUB_HOOK_SECRET)) {
 87 |         fail('Missing hook secret configuration!');
 88 |     }
 89 |     if (! isset($_SERVER['HTTP_X_HUB_SIGNATURE'])) {
 90 |         fail("HTTP header 'X-Hub-Signature' is missing.");
 91 |     } elseif (! extension_loaded('hash')) {
 92 |         fail("Missing 'hash' extension to check the secret code validity.");
 93 |     }
 94 | 
 95 |     [$algo, $hash] = explode('=', $_SERVER['HTTP_X_HUB_SIGNATURE'], 2) + ['', ''];
 96 |     if (! in_array($algo, ['sha1', 'sha256', 'sha512'], true)) {
 97 |         fail("Hash algorithm '$algo' is not allowed.");
 98 |     }
 99 |     if (! in_array($algo, hash_algos(), true)) {
100 |         fail("Hash algorithm '$algo' is not supported.");
101 |     }
102 |     $rawPost = file_get_contents('php://input');
103 |     $newhash = hash_hmac($algo, $rawPost, GITHUB_HOOK_SECRET);
104 |     if (hash_equals($hash, $newhash)) {
105 |         return;
106 |     }
107 | 
108 |     fail('Hook secret does not match.');
109 | }
110 | 
111 | /**
112 |  * Creates a GitHub release
113 |  */
114 | function github_make_release($repo, $tag, $version, $description)
115 | {
116 |     global $curlBaseOpts;
117 | 
118 |     $ch = curl_init();
119 | 
120 |     $result = [
121 |         'release' => [
122 |             'project' => $repo,
123 |             'tag' => $tag,
124 |             'version' => $version,
125 |             'description' => $description,
126 |         ],
127 |     ];
128 | 
129 |     //set the url, number of POST vars, POST data
130 |     curl_setopt_array($ch, $curlBaseOpts);
131 |     curl_setopt($ch, CURLOPT_URL, 'https://api.github.com/repos/' . $repo . '/releases');
132 |     curl_setopt($ch, CURLOPT_POST, 1);
133 |     curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['tag_name' => $tag, 'name' => $version, 'body' => $description]));
134 | 
135 |     //execute post
136 |     $response = curl_exec($ch);
137 | 
138 |     continueOrFailOnHttpCode(curl_getinfo($ch, CURLINFO_HTTP_CODE));
139 | 
140 |     //close connection
141 |     curl_close($ch);
142 | 
143 |     $result['response'] = json_decode($response);
144 | 
145 |     return $result;
146 | }
147 | 
148 | /**
149 |  * Posts a comment on GitHub pull request
150 |  */
151 | function github_comment_pull($repo, $pullid, $comment)
152 | {
153 |     global $curlBaseOpts;
154 | 
155 |     $ch = curl_init();
156 | 
157 |     //set the url, number of POST vars, POST data
158 |     curl_setopt_array($ch, $curlBaseOpts);
159 |     curl_setopt($ch, CURLOPT_URL, 'https://api.github.com/repos/' . $repo . '/issues/' . $pullid . '/comments');
160 |     curl_setopt($ch, CURLOPT_POST, 1);
161 |     curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['body' => $comment]));
162 | 
163 |     //execute post
164 |     $result = curl_exec($ch);
165 | 
166 |     continueOrFailOnHttpCode(curl_getinfo($ch, CURLINFO_HTTP_CODE));
167 | 
168 |     //close connection
169 |     curl_close($ch);
170 | 
171 |     return json_decode($result, true);
172 | }
173 | 
174 | /**
175 |  * Posts a comment on GitHub commit request
176 |  */
177 | function github_comment_commit($repo, $sha, $comment)
178 | {
179 |     global $curlBaseOpts;
180 | 
181 |     $ch = curl_init();
182 | 
183 |     //set the url, number of POST vars, POST data
184 |     curl_setopt_array($ch, $curlBaseOpts);
185 |     curl_setopt($ch, CURLOPT_URL, 'https://api.github.com/repos/' . $repo . '/commits/' . $sha . '/comments');
186 |     curl_setopt($ch, CURLOPT_POST, 1);
187 |     curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['body' => $comment]));
188 | 
189 |     //execute post
190 |     $result = curl_exec($ch);
191 | 
192 |     continueOrFailOnHttpCode(curl_getinfo($ch, CURLINFO_HTTP_CODE));
193 | 
194 |     //close connection
195 |     curl_close($ch);
196 | 
197 |     return json_decode($result, true);
198 | }
199 | 
200 | /**
201 |  * Returns list of pull request commits.
202 |  */
203 | function github_pull_commits($repo, $pullid)
204 | {
205 |     global $curlBaseOpts;
206 | 
207 |     $ch = curl_init();
208 |     curl_setopt_array($ch, $curlBaseOpts);
209 |     curl_setopt($ch, CURLOPT_URL, 'https://api.github.com/repos/' . $repo . '/pulls/' . $pullid . '/commits');
210 | 
211 |     //execute post
212 |     $result = curl_exec($ch);
213 | 
214 |     continueOrFailOnHttpCode(curl_getinfo($ch, CURLINFO_HTTP_CODE));
215 | 
216 |     //close connection
217 |     curl_close($ch);
218 | 
219 |     return json_decode($result, true);
220 | }
221 | 
222 | /**
223 |  * Returns diff of pull request commit detail.
224 |  */
225 | function github_commit_detail($repo, $commit)
226 | {
227 |     global $curlBaseOpts;
228 | 
229 |     $ch = curl_init();
230 |     curl_setopt_array($ch, $curlBaseOpts);
231 |     curl_setopt($ch, CURLOPT_URL, 'https://api.github.com/repos/' . $repo . '/commits/' . $commit);
232 | 
233 |     //execute post
234 |     $result = curl_exec($ch);
235 | 
236 |     continueOrFailOnHttpCode(curl_getinfo($ch, CURLINFO_HTTP_CODE));
237 | 
238 |     //close connection
239 |     curl_close($ch);
240 | 
241 |     return json_decode($result, true);
242 | }
243 | 
244 | /**
245 |  * Returns diff of pull request commit detail.
246 |  */
247 | function github_commit_comments($repo, $sha)
248 | {
249 |     global $curlBaseOpts;
250 | 
251 |     $ch = curl_init();
252 |     curl_setopt_array($ch, $curlBaseOpts);
253 |     curl_setopt($ch, CURLOPT_URL, 'https://api.github.com/repos/' . $repo . '/commits/' . $sha . '/comments');
254 | 
255 |     //execute post
256 |     $result = curl_exec($ch);
257 | 
258 |     continueOrFailOnHttpCode(curl_getinfo($ch, CURLINFO_HTTP_CODE));
259 | 
260 |     //close connection
261 |     curl_close($ch);
262 | 
263 |     return json_decode($result, true);
264 | }
265 | 
266 | /**
267 |  * Returns diff of pull request commits.
268 |  */
269 | function github_pull_diff($repo, $pullid)
270 | {
271 |     global $curlBaseOpts;
272 | 
273 |     $ch = curl_init();
274 |     curl_setopt_array($ch, $curlBaseOpts);
275 |     curl_setopt($ch, CURLOPT_URL, 'https://github.com/' . $repo . '/pull/' . $pullid . '.patch');
276 | 
277 |     //execute post
278 |     $result = curl_exec($ch);
279 | 
280 |     continueOrFailOnHttpCode(curl_getinfo($ch, CURLINFO_HTTP_CODE));
281 | 
282 |     //close connection
283 |     curl_close($ch);
284 | 
285 |     return $result;
286 | }
287 | 
288 | /**
289 |  * Trigger website rendering.
290 |  */
291 | function trigger_website_render()
292 | {
293 |     $file = fopen(WEBSITE_HOOK, 'w');
294 |     fclose($file);
295 | }
296 | 
297 | /**
298 |  * Trigger website rendering.
299 |  */
300 | function trigger_docs_render()
301 | {
302 |     $file = fopen(DOCS_HOOK, 'w');
303 |     fclose($file);
304 | }
305 | 
306 | /**
307 |  * Issues JSON response
308 |  *
309 |  * @param mixed $data JSON data to print
310 |  */
311 | function json_response($data, $status = 'success', $message = null)
312 | {
313 |     header('Content-Type: application/json; charset=UTF-8');
314 |     header('X-Content-Type-Options: nosniff');
315 | 
316 |     $response = ['status' => $status];
317 |     if (isset($data)) {
318 |         $response['data'] = $data;
319 |     }
320 |     if (isset($message)) {
321 |         $response['message'] = $message;
322 |     }
323 | 
324 |     echo json_encode($response, JSON_PRETTY_PRINT);
325 | }
326 | 
327 | function continueOrFailOnHttpCode(int $httpCode): void
328 | {
329 |     if ($httpCode > 204) {
330 |         fail('Request failed with a code ' . $httpCode);
331 |     }
332 | }
333 | 
334 | /**
335 |  * Terminates request with error
336 |  */
337 | function fail($message, $code = 500)
338 | {
339 |     http_response_code($code);
340 |     json_response(null, 'error', $message);
341 | 
342 |     die;
343 | }
344 | 


--------------------------------------------------------------------------------
/demo/bin/pma-demo-update:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | 
  3 | # Script to update repositories for the demo server
  4 | # Requires $HOME/scripts to be a checkout of the scripts repository
  5 | 
  6 | # Fail on undefined variables
  7 | set -u
  8 | # Fail on failure
  9 | set -e
 10 | # If a script fails, stop before the next pipe
 11 | set -o pipefail
 12 | 
 13 | FORCE_MODE="0"
 14 | QUIET_MODE="0"
 15 | OFFLINE_MODE="0"
 16 | LOG_FILE="/dev/null"
 17 | 
 18 | # Source: https://stackoverflow.com/a/31024664/5155484
 19 | while [[ $# -gt 0 ]]
 20 | do
 21 |     key="$1"
 22 |     while [[ ${key+x} ]]
 23 |     do
 24 |         case $key in
 25 |             --offline)
 26 |                 OFFLINE_MODE="1"
 27 |                 ;;
 28 |             --force)
 29 |                 FORCE_MODE="1"
 30 |                 ;;
 31 |             -q)
 32 |                 QUIET_MODE="1"
 33 |                 ;;
 34 |             --log-file)
 35 |                 LOG_FILE="$2"
 36 |                 shift # option has parameter
 37 |                 ;;
 38 |             *)
 39 |                 # unknown option
 40 |                 echo "Unknown option: $key" #1>&2
 41 |                 exit 10
 42 |                 ;;
 43 |         esac
 44 |         # prepare for next option in this key, if any
 45 |         [[ "$key" = -? || "$key" == --* ]] && unset key || key="${key/#-?/-}"
 46 |     done
 47 |     shift # option(s) fully processed, proceed to next input argument
 48 | done
 49 | 
 50 | debugLog() {
 51 |     echo "$1" >> "$LOG_FILE"
 52 |     if [ "${QUIET_MODE}" = "1" ] ; then
 53 |         return
 54 |     fi
 55 |     echo "$1"
 56 | }
 57 | 
 58 | SCRIPTS_FOLDER="${SCRIPTS_FOLDER:-$HOME/scripts}"
 59 | 
 60 | # Directory where repositories are stored
 61 | GIT_STORAGE="${GIT_STORAGE:-$HOME/.pma-demo}"
 62 | 
 63 | # Directory where built folders are stored
 64 | WEB_STORAGE="${WEB_STORAGE:-$HOME/.pma-demo-web}"
 65 | # The user group to own the files
 66 | WEB_GROUP="${WEB_GROUP:-www-data}"
 67 | 
 68 | # Remote URL of repository to checkout
 69 | REMOTE="${REMOTE:-https://github.com/phpmyadmin/phpmyadmin.git}"
 70 | REMOTE_THEMES="${REMOTE_THEMES:-https://github.com/phpmyadmin/themes.git}"
 71 | 
 72 | # List of repositories to checkout
 73 | VARIANTS=$(awk '/^variants/ {print $3}' "$SCRIPTS_FOLDER/demo/php/versions.ini")
 74 | THEMES=$(awk '/^themes/ {print $3}' "$SCRIPTS_FOLDER/demo/php/versions.ini")
 75 | 
 76 | debugLog "Updating themes"
 77 | 
 78 | # Clone / update themes
 79 | if [ -d "$GIT_STORAGE/themes/.git" ] ; then
 80 |     cd "$GIT_STORAGE/themes"
 81 |     # Remove local theme changes
 82 |     git reset --hard -q
 83 |     if [ $OFFLINE_MODE = 0 ] ; then
 84 |         git pull -q
 85 |     fi
 86 | else
 87 |     git clone "$REMOTE_THEMES" "$GIT_STORAGE/themes"
 88 | fi
 89 | 
 90 | # Clone / update phpMyAdmin
 91 | if [ -d "$GIT_STORAGE/phpMyAdmin/.git" ] ; then
 92 |     cd "$GIT_STORAGE/phpMyAdmin"
 93 |     # Remove local changes
 94 |     git reset --hard -q
 95 |     if [ $OFFLINE_MODE = 0 ] ; then
 96 |         git fetch --all -p
 97 |     fi
 98 |     git checkout temp 2> /dev/null 1> /dev/null
 99 | else
100 |     git clone "$REMOTE" "$GIT_STORAGE/phpMyAdmin"
101 |     git checkout -b temp 2> /dev/null 1> /dev/null
102 | fi
103 | 
104 | debugLog "Deleting stale worktrees"
105 | cd "$GIT_STORAGE/phpMyAdmin"
106 | 
107 | WORKTREES="$(git worktree list --porcelain | grep -F "worktree" | cut -d ' ' -f 2)"
108 | 
109 | # Delete stale worktrees
110 | for WORKTREE_PATH in $WORKTREES ; do
111 |     if [ "$WORKTREE_PATH" = "$GIT_STORAGE/phpMyAdmin" ] ; then
112 |         # Skip the current path
113 |         continue
114 |     fi
115 | 
116 |     debugLog "Checking worktree $WORKTREE_PATH"
117 |     WORKTREE_NAME=${WORKTREE_PATH##*/}
118 |     for VARIANT_DATA in $VARIANTS ; do
119 |         VARIANT_NAME=${VARIANT_DATA%%:*}
120 |         if [ -z "$VARIANT_NAME" ] ; then
121 |             debugLog "Invalid variant data: $VARIANT_DATA"
122 |             continue
123 |         fi
124 | 
125 |         if [ "$VARIANT_NAME" = "$WORKTREE_NAME" ] ; then
126 |             # Skip the item
127 |             continue 2
128 |         fi
129 |     done
130 |     debugLog "Deleting stale worktree $WORKTREE_PATH"
131 |     if [ -d "$WORKTREE_PATH/.git" ] ; then
132 |         git worktree remove "$WORKTREE_PATH"
133 |     else
134 |         rm -r "$WORKTREE_PATH"
135 |     fi
136 | done
137 | 
138 | unset WORKTREES
139 | cd - > /dev/null
140 | 
141 | # Build worktrees
142 | for VARIANT_DATA in $VARIANTS ; do
143 |     VARIANT_NAME=${VARIANT_DATA%%:*}
144 |     VARIANT_BRANCH=${VARIANT_DATA##*:}
145 |     if [ -z "$VARIANT_NAME" ] || [ -z "$VARIANT_BRANCH" ] ; then
146 |         debugLog "Invalid variant data: $VARIANT_DATA"
147 |         continue
148 |     fi
149 | 
150 |     # Only one worktree per branch is possible
151 |     WORKTREE_PATH="$GIT_STORAGE/$VARIANT_BRANCH"
152 | 
153 |     if [ -d "$WORKTREE_PATH" ] ; then
154 |         debugLog "Updating worktree $VARIANT_BRANCH for $VARIANT_NAME at $WORKTREE_PATH"
155 |         cd "$WORKTREE_PATH"
156 |         # Remove local changes
157 |         git reset --hard -q
158 |         if [ $OFFLINE_MODE = 0 ] ; then
159 |             git pull -q
160 |         fi
161 |         cd - > /dev/null
162 |     else
163 |         debugLog "Creating worktree $VARIANT_BRANCH for $VARIANT_NAME at $WORKTREE_PATH"
164 |         git worktree add "$WORKTREE_PATH" "$VARIANT_BRANCH"
165 |     fi
166 | done
167 | 
168 | # Cleanup worktree folders
169 | for VARIANT_DATA in $VARIANTS ; do
170 |     VARIANT_NAME=${VARIANT_DATA%%:*}
171 |     VARIANT_BRANCH=${VARIANT_DATA##*:}
172 |     if [ -z "$VARIANT_NAME" ] || [ -z "$VARIANT_BRANCH" ] ; then
173 |         debugLog "Invalid variant data: $VARIANT_DATA"
174 |         continue
175 |     fi
176 | 
177 |     WORKTREE_PATH="$GIT_STORAGE/$VARIANT_BRANCH"
178 | 
179 |     #if [ -d "$WORKTREE_PATH/release" ] ; then
180 |         #debugLog "Cleaning old release files"
181 |         #rm -rf "$WORKTREE_PATH/release"
182 |     #fi
183 | done
184 | 
185 | # Build web folders
186 | for VARIANT_DATA in $VARIANTS ; do
187 |     VARIANT_NAME=${VARIANT_DATA%%:*}
188 |     VARIANT_BRANCH=${VARIANT_DATA##*:}
189 |     if [ -z "$VARIANT_NAME" ] || [ -z "$VARIANT_BRANCH" ] ; then
190 |         debugLog "Invalid variant data: $VARIANT_DATA"
191 |         continue
192 |     fi
193 | 
194 |     WORKTREE_PATH="$GIT_STORAGE/$VARIANT_BRANCH"
195 | 
196 |     debugLog "Building from $WORKTREE_PATH"
197 |     cd "$WORKTREE_PATH"
198 |     VERSION="$(grep -F "version" package.json | cut -d '"' -f 4)"
199 |     debugLog "Building version $VERSION from branch $VARIANT_BRANCH"
200 | 
201 |     SKIP_BUILD=0
202 |     if [ -f "$WORKTREE_PATH/release/phpMyAdmin-$VERSION.json" ] ; then
203 |         BUILT_COMMIT="$(grep -F "commit" "$WORKTREE_PATH/release/phpMyAdmin-$VERSION.json" |cut -d '"' -f 4)"
204 |         debugLog "Already built at commit $BUILT_COMMIT"
205 | 
206 |         CURRENT_COMMIT=$(git log -n 1 --format=format:'%H')
207 |         if [ "$CURRENT_COMMIT" = "$BUILT_COMMIT" ] && [ $FORCE_MODE = 0 ] ; then
208 |             debugLog "Skipping building version $VERSION from branch $VARIANT_BRANCH"
209 |             SKIP_BUILD=1
210 |             continue
211 |         fi
212 |     fi
213 | 
214 |     RELEASE_SCRIPT="$WORKTREE_PATH/scripts/create-release.sh"
215 |     THEMES_FOLDER="themes"
216 |     if [ -f "$WORKTREE_PATH/bin/internal/create-release.sh" ] ; then
217 |         RELEASE_SCRIPT="$WORKTREE_PATH/bin/internal/create-release.sh"
218 |         THEMES_FOLDER="public/themes"
219 |     fi
220 | 
221 |     if [ $SKIP_BUILD = 0 ] ; then
222 |         SCRIPT_OPTIONS="--daily --no-sign --revision-info --compressions tgz --kits all-languages"
223 |         if [ "$VARIANT_BRANCH" = "STABLE" ] ; then
224 |             # Remove this when 5.2.2 is out
225 |             SCRIPT_OPTIONS="--daily"
226 |             debugLog "Skipping, the build is broken anyway"
227 |             continue
228 |         fi
229 |         debugLog "Building the release"
230 |         COMPOSER_DISABLE_NETWORK="$OFFLINE_MODE" "$RELEASE_SCRIPT" "$VERSION" "$VARIANT_BRANCH" $SCRIPT_OPTIONS 2> $LOG_FILE 1> $LOG_FILE
231 |     fi
232 | 
233 |     TARBALL_TO_INSTALL="$WORKTREE_PATH/release/phpMyAdmin-$VERSION-all-languages.tar.gz"
234 |     if [ ! -f "$TARBALL_TO_INSTALL" ] ; then
235 |         debugLog "Unable to find $TARBALL_TO_INSTALL"
236 |         continue
237 |     fi
238 | 
239 |     WEB_FOLDER="$WEB_STORAGE/$VARIANT_NAME"
240 |     if [ -d "$WEB_FOLDER" ] ; then
241 |         debugLog "Cleaning up $WEB_FOLDER"
242 |         rm -rf "$WEB_FOLDER"
243 |     fi
244 | 
245 |     debugLog "Creating $WEB_FOLDER"
246 |     mkdir "$WEB_FOLDER"
247 |     chgrp "$WEB_GROUP" "$WEB_FOLDER"
248 | 
249 |     debugLog "Extracting $TARBALL_TO_INSTALL to $WEB_FOLDER"
250 |     tar -xz --strip-components=1 --directory="${WEB_FOLDER}" -f "${TARBALL_TO_INSTALL}"
251 | 
252 |     # Symlink configuration
253 |     FLAVOUR=${VARIANT_NAME#*-}
254 |     debugLog "Flavour $FLAVOUR, copying configs"
255 |     if [ -f "$SCRIPTS_FOLDER/demo/php/config-$FLAVOUR.inc.php" ] ; then
256 |         cp "$SCRIPTS_FOLDER/demo/php/config-$FLAVOUR.inc.php" "$WEB_FOLDER/config.inc.php"
257 |     else
258 |         cp "$SCRIPTS_FOLDER/demo/php/config.inc.php" "$WEB_FOLDER/config.inc.php"
259 |     fi
260 |     cp "$SCRIPTS_FOLDER/demo/php/"config.*.inc.php "$WEB_FOLDER/"
261 | 
262 |     # Link themes
263 |     for THEME in $THEMES ; do
264 |         if [ ! -e "$WEB_FOLDER/$THEMES_FOLDER/$THEME" ] ; then
265 |             debugLog "Copying theme: $THEME"
266 |             cp -rp "$GIT_STORAGE/themes/$THEME" "$WEB_FOLDER/$THEMES_FOLDER/$THEME"
267 |         fi
268 |     done
269 | 
270 |     # Apply permissions globally
271 |     chgrp -R "$WEB_GROUP" "$WEB_FOLDER"
272 | 
273 |     # Apply permissions to files and folders
274 |     find "$WEB_FOLDER" -type d -exec chmod 0755 {} \;
275 |     find "$WEB_FOLDER" -type f -exec chmod 0644 {} \;
276 | 
277 |     # Create temp dir
278 |     mkdir -p "$WEB_FOLDER/tmp/"
279 |     chmod 770 "$WEB_FOLDER/tmp/"
280 |     chgrp "$WEB_GROUP" "$WEB_FOLDER/tmp/"
281 | done
282 | 
283 | debugLog "Deleting stale directories"
284 | 
285 | # Delete stale directories
286 | find "$WEB_STORAGE" -maxdepth 1 -mindepth 1 -type d | while read DIRNAME ; do
287 |     FOLDER_NAME=${DIRNAME##*/}
288 | 
289 |     # Build web folders
290 |     for VARIANT_DATA in $VARIANTS ; do
291 |         VARIANT_NAME=${VARIANT_DATA%%:*}
292 |         VARIANT_BRANCH=${VARIANT_DATA##*:}
293 |         if [ -z "$VARIANT_NAME" ] || [ -z "$VARIANT_BRANCH" ] ; then
294 |             debugLog "Invalid variant data: $VARIANT_DATA"
295 |             continue
296 |         fi
297 | 
298 |         if [ "$FOLDER_NAME" = "$VARIANT_NAME" ] ; then
299 |             debugLog "Known variant: $FOLDER_NAME"
300 |             continue 2
301 |         fi
302 |     done
303 | 
304 |     debugLog "Deleting stale variant $FOLDER_NAME"
305 |     #rm -rf "$DIRNAME"
306 | done
307 | 
308 | debugLog "All done"
309 | 


--------------------------------------------------------------------------------
/demo/sql/create_tables.sql:
--------------------------------------------------------------------------------
  1 | -- --------------------------------------------------------
  2 | -- SQL Commands to set up the pmadb as described in the documentation.
  3 | --
  4 | -- This file is meant for use with MySQL 5 and above!
  5 | --
  6 | -- This script expects the user pma to already be existing. If we would put a
  7 | -- line here to create him too many users might just use this script and end
  8 | -- up with having the same password for the controluser.
  9 | --
 10 | -- This user "pma" must be defined in config.inc.php (controluser/controlpass)
 11 | --
 12 | -- Please don't forget to set up the tablenames in config.inc.php
 13 | --
 14 | 
 15 | -- --------------------------------------------------------
 16 | 
 17 | --
 18 | -- Database : `phpmyadmin`
 19 | --
 20 | CREATE DATABASE IF NOT EXISTS `phpmyadmin`
 21 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
 22 | USE phpmyadmin;
 23 | 
 24 | -- --------------------------------------------------------
 25 | 
 26 | --
 27 | -- Privileges
 28 | --
 29 | -- (activate this statement if necessary)
 30 | -- GRANT SELECT, INSERT, DELETE, UPDATE, ALTER ON `phpmyadmin`.* TO
 31 | --    'pma'@localhost;
 32 | 
 33 | -- --------------------------------------------------------
 34 | 
 35 | --
 36 | -- Table structure for table `pma__bookmark`
 37 | --
 38 | 
 39 | CREATE TABLE IF NOT EXISTS `pma__bookmark` (
 40 |   `id` int(10) unsigned NOT NULL auto_increment,
 41 |   `dbase` varchar(255) NOT NULL default '',
 42 |   `user` varchar(255) NOT NULL default '',
 43 |   `label` varchar(255) COLLATE utf8_general_ci NOT NULL default '',
 44 |   `query` text NOT NULL,
 45 |   PRIMARY KEY  (`id`)
 46 | )
 47 |   COMMENT='Bookmarks'
 48 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
 49 | 
 50 | -- --------------------------------------------------------
 51 | 
 52 | --
 53 | -- Table structure for table `pma__column_info`
 54 | --
 55 | 
 56 | CREATE TABLE IF NOT EXISTS `pma__column_info` (
 57 |   `id` int(5) unsigned NOT NULL auto_increment,
 58 |   `db_name` varchar(64) NOT NULL default '',
 59 |   `table_name` varchar(64) NOT NULL default '',
 60 |   `column_name` varchar(64) NOT NULL default '',
 61 |   `comment` varchar(255) COLLATE utf8_general_ci NOT NULL default '',
 62 |   `mimetype` varchar(255) COLLATE utf8_general_ci NOT NULL default '',
 63 |   `transformation` varchar(255) NOT NULL default '',
 64 |   `transformation_options` varchar(255) NOT NULL default '',
 65 |   `input_transformation` varchar(255) NOT NULL default '',
 66 |   `input_transformation_options` varchar(255) NOT NULL default '',
 67 |   PRIMARY KEY  (`id`),
 68 |   UNIQUE KEY `db_name` (`db_name`,`table_name`,`column_name`)
 69 | )
 70 |   COMMENT='Column information for phpMyAdmin'
 71 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
 72 | 
 73 | -- --------------------------------------------------------
 74 | 
 75 | --
 76 | -- Table structure for table `pma__history`
 77 | --
 78 | 
 79 | CREATE TABLE IF NOT EXISTS `pma__history` (
 80 |   `id` bigint(20) unsigned NOT NULL auto_increment,
 81 |   `username` varchar(64) NOT NULL default '',
 82 |   `db` varchar(64) NOT NULL default '',
 83 |   `table` varchar(64) NOT NULL default '',
 84 |   `timevalue` timestamp NOT NULL default CURRENT_TIMESTAMP,
 85 |   `sqlquery` text NOT NULL,
 86 |   PRIMARY KEY  (`id`),
 87 |   KEY `username` (`username`,`db`,`table`,`timevalue`)
 88 | )
 89 |   COMMENT='SQL history for phpMyAdmin'
 90 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
 91 | 
 92 | -- --------------------------------------------------------
 93 | 
 94 | --
 95 | -- Table structure for table `pma__pdf_pages`
 96 | --
 97 | 
 98 | CREATE TABLE IF NOT EXISTS `pma__pdf_pages` (
 99 |   `db_name` varchar(64) NOT NULL default '',
100 |   `page_nr` int(10) unsigned NOT NULL auto_increment,
101 |   `page_descr` varchar(50) COLLATE utf8_general_ci NOT NULL default '',
102 |   PRIMARY KEY  (`page_nr`),
103 |   KEY `db_name` (`db_name`)
104 | )
105 |   COMMENT='PDF relation pages for phpMyAdmin'
106 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
107 | 
108 | -- --------------------------------------------------------
109 | 
110 | --
111 | -- Table structure for table `pma__recent`
112 | --
113 | 
114 | CREATE TABLE IF NOT EXISTS `pma__recent` (
115 |   `username` varchar(64) NOT NULL,
116 |   `tables` text NOT NULL,
117 |   PRIMARY KEY (`username`)
118 | )
119 |   COMMENT='Recently accessed tables'
120 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
121 | 
122 | -- --------------------------------------------------------
123 | 
124 | --
125 | -- Table structure for table `pma__favorite`
126 | --
127 | 
128 | CREATE TABLE IF NOT EXISTS `pma__favorite` (
129 |   `username` varchar(64) NOT NULL,
130 |   `tables` text NOT NULL,
131 |   PRIMARY KEY (`username`)
132 | )
133 |   COMMENT='Favorite tables'
134 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
135 | 
136 | -- --------------------------------------------------------
137 | 
138 | --
139 | -- Table structure for table `pma__table_uiprefs`
140 | --
141 | 
142 | CREATE TABLE IF NOT EXISTS `pma__table_uiprefs` (
143 |   `username` varchar(64) NOT NULL,
144 |   `db_name` varchar(64) NOT NULL,
145 |   `table_name` varchar(64) NOT NULL,
146 |   `prefs` text NOT NULL,
147 |   `last_update` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
148 |   PRIMARY KEY (`username`,`db_name`,`table_name`)
149 | )
150 |   COMMENT='Tables'' UI preferences'
151 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
152 | 
153 | -- --------------------------------------------------------
154 | 
155 | --
156 | -- Table structure for table `pma__relation`
157 | --
158 | 
159 | CREATE TABLE IF NOT EXISTS `pma__relation` (
160 |   `master_db` varchar(64) NOT NULL default '',
161 |   `master_table` varchar(64) NOT NULL default '',
162 |   `master_field` varchar(64) NOT NULL default '',
163 |   `foreign_db` varchar(64) NOT NULL default '',
164 |   `foreign_table` varchar(64) NOT NULL default '',
165 |   `foreign_field` varchar(64) NOT NULL default '',
166 |   PRIMARY KEY  (`master_db`,`master_table`,`master_field`),
167 |   KEY `foreign_field` (`foreign_db`,`foreign_table`)
168 | )
169 |   COMMENT='Relation table'
170 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
171 | 
172 | -- --------------------------------------------------------
173 | 
174 | --
175 | -- Table structure for table `pma__table_coords`
176 | --
177 | 
178 | CREATE TABLE IF NOT EXISTS `pma__table_coords` (
179 |   `db_name` varchar(64) NOT NULL default '',
180 |   `table_name` varchar(64) NOT NULL default '',
181 |   `pdf_page_number` int(11) NOT NULL default '0',
182 |   `x` float unsigned NOT NULL default '0',
183 |   `y` float unsigned NOT NULL default '0',
184 |   PRIMARY KEY  (`db_name`,`table_name`,`pdf_page_number`)
185 | )
186 |   COMMENT='Table coordinates for phpMyAdmin PDF output'
187 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
188 | 
189 | -- --------------------------------------------------------
190 | 
191 | --
192 | -- Table structure for table `pma__table_info`
193 | --
194 | 
195 | CREATE TABLE IF NOT EXISTS `pma__table_info` (
196 |   `db_name` varchar(64) NOT NULL default '',
197 |   `table_name` varchar(64) NOT NULL default '',
198 |   `display_field` varchar(64) NOT NULL default '',
199 |   PRIMARY KEY  (`db_name`,`table_name`)
200 | )
201 |   COMMENT='Table information for phpMyAdmin'
202 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
203 | 
204 | -- --------------------------------------------------------
205 | 
206 | --
207 | -- Table structure for table `pma__tracking`
208 | --
209 | 
210 | CREATE TABLE IF NOT EXISTS `pma__tracking` (
211 |   `db_name` varchar(64) NOT NULL,
212 |   `table_name` varchar(64) NOT NULL,
213 |   `version` int(10) unsigned NOT NULL,
214 |   `date_created` datetime NOT NULL,
215 |   `date_updated` datetime NOT NULL,
216 |   `schema_snapshot` text NOT NULL,
217 |   `schema_sql` text,
218 |   `data_sql` longtext,
219 |   `tracking` set('UPDATE','REPLACE','INSERT','DELETE','TRUNCATE','CREATE DATABASE','ALTER DATABASE','DROP DATABASE','CREATE TABLE','ALTER TABLE','RENAME TABLE','DROP TABLE','CREATE INDEX','DROP INDEX','CREATE VIEW','ALTER VIEW','DROP VIEW') default NULL,
220 |   `tracking_active` int(1) unsigned NOT NULL default '1',
221 |   PRIMARY KEY  (`db_name`,`table_name`,`version`)
222 | )
223 |   COMMENT='Database changes tracking for phpMyAdmin'
224 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
225 | 
226 | -- --------------------------------------------------------
227 | 
228 | --
229 | -- Table structure for table `pma__userconfig`
230 | --
231 | 
232 | CREATE TABLE IF NOT EXISTS `pma__userconfig` (
233 |   `username` varchar(64) NOT NULL,
234 |   `timevalue` timestamp NOT NULL default CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
235 |   `config_data` text NOT NULL,
236 |   PRIMARY KEY  (`username`)
237 | )
238 |   COMMENT='User preferences storage for phpMyAdmin'
239 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
240 | 
241 | -- --------------------------------------------------------
242 | 
243 | --
244 | -- Table structure for table `pma__users`
245 | --
246 | 
247 | CREATE TABLE IF NOT EXISTS `pma__users` (
248 |   `username` varchar(64) NOT NULL,
249 |   `usergroup` varchar(64) NOT NULL,
250 |   PRIMARY KEY (`username`,`usergroup`)
251 | )
252 |   COMMENT='Users and their assignments to user groups'
253 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
254 | 
255 | -- --------------------------------------------------------
256 | 
257 | --
258 | -- Table structure for table `pma__usergroups`
259 | --
260 | 
261 | CREATE TABLE IF NOT EXISTS `pma__usergroups` (
262 |   `usergroup` varchar(64) NOT NULL,
263 |   `tab` varchar(64) NOT NULL,
264 |   `allowed` enum('Y','N') NOT NULL DEFAULT 'N',
265 |   PRIMARY KEY (`usergroup`,`tab`,`allowed`)
266 | )
267 |   COMMENT='User groups with configured menu items'
268 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
269 | 
270 | -- --------------------------------------------------------
271 | 
272 | --
273 | -- Table structure for table `pma__navigationhiding`
274 | --
275 | 
276 | CREATE TABLE IF NOT EXISTS `pma__navigationhiding` (
277 |   `username` varchar(64) NOT NULL,
278 |   `item_name` varchar(64) NOT NULL,
279 |   `item_type` varchar(64) NOT NULL,
280 |   `db_name` varchar(64) NOT NULL,
281 |   `table_name` varchar(64) NOT NULL,
282 |   PRIMARY KEY (`username`,`item_name`,`item_type`,`db_name`,`table_name`)
283 | )
284 |   COMMENT='Hidden items of navigation tree'
285 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
286 | 
287 | -- --------------------------------------------------------
288 | 
289 | --
290 | -- Table structure for table `pma__savedsearches`
291 | --
292 | 
293 | CREATE TABLE IF NOT EXISTS `pma__savedsearches` (
294 |   `id` int(5) unsigned NOT NULL auto_increment,
295 |   `username` varchar(64) NOT NULL default '',
296 |   `db_name` varchar(64) NOT NULL default '',
297 |   `search_name` varchar(64) NOT NULL default '',
298 |   `search_data` text NOT NULL,
299 |   PRIMARY KEY  (`id`),
300 |   UNIQUE KEY `u_savedsearches_username_dbname` (`username`,`db_name`,`search_name`)
301 | )
302 |   COMMENT='Saved searches'
303 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
304 | 
305 | -- --------------------------------------------------------
306 | 
307 | --
308 | -- Table structure for table `pma__central_columns`
309 | --
310 | 
311 | CREATE TABLE IF NOT EXISTS `pma__central_columns` (
312 |   `db_name` varchar(64) NOT NULL,
313 |   `col_name` varchar(64) NOT NULL,
314 |   `col_type` varchar(64) NOT NULL,
315 |   `col_length` text,
316 |   `col_collation` varchar(64) NOT NULL,
317 |   `col_isNull` boolean NOT NULL,
318 |   `col_extra` varchar(255) default '',
319 |   `col_default` text,
320 |   PRIMARY KEY (`db_name`,`col_name`)
321 | )
322 |   COMMENT='Central list of columns'
323 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
324 | 
325 | -- --------------------------------------------------------
326 | 
327 | --
328 | -- Table structure for table `pma__designer_settings`
329 | --
330 | 
331 | CREATE TABLE IF NOT EXISTS `pma__designer_settings` (
332 |   `username` varchar(64) NOT NULL,
333 |   `settings_data` text NOT NULL,
334 |   PRIMARY KEY (`username`)
335 | )
336 |   COMMENT='Settings related to Designer'
337 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
338 | 
339 | -- --------------------------------------------------------
340 | 
341 | --
342 | -- Table structure for table `pma__export_templates`
343 | --
344 | 
345 | CREATE TABLE IF NOT EXISTS `pma__export_templates` (
346 |   `id` int(5) unsigned NOT NULL AUTO_INCREMENT,
347 |   `username` varchar(64) NOT NULL,
348 |   `export_type` varchar(10) NOT NULL,
349 |   `template_name` varchar(64) NOT NULL,
350 |   `template_data` text NOT NULL,
351 |   PRIMARY KEY (`id`),
352 |   UNIQUE KEY `u_user_type_template` (`username`,`export_type`,`template_name`)
353 | )
354 |   COMMENT='Saved export templates'
355 |   DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;
356 | 


--------------------------------------------------------------------------------
/phpmyadmin-report.php:
--------------------------------------------------------------------------------
  1 | #!/bin/php
  2 | <?php
  3 | 
  4 | declare(strict_types=1);
  5 | 
  6 | if (PHP_SAPI !== 'cli') {
  7 |     exit;
  8 | }
  9 | 
 10 | if (PHP_VERSION_ID < 80100) {// 80 1 00
 11 |     echo 'You need to use PHP 8.1.0 or above to run this script.' . PHP_EOL;
 12 |     echo 'Current detected version: (' . PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION . ') (' . PHP_VERSION_ID . ').' . PHP_EOL;
 13 |     exit(1);
 14 | }
 15 | 
 16 | class Reports
 17 | {
 18 |     private const PROJECTS = [
 19 |         'github.com' => [
 20 |             'phpmyadmin/phpmyadmin',
 21 |             'phpmyadmin/docker',
 22 |             'phpmyadmin/website',
 23 |             'phpmyadmin/sql-parser',
 24 |             'phpmyadmin/motranslator',
 25 |             'phpmyadmin/shapefile',
 26 |             'phpmyadmin/simple-math',
 27 |             'phpmyadmin/localized_docs',
 28 |             'phpmyadmin/error-reporting-server',
 29 |             'phpmyadmin/twig-i18n-extension',
 30 |             'docker-library/docs',
 31 |             'docker-library/official-images',
 32 |             // Disable private repos
 33 |             // 'phpmyadmin/phpmyadmin-security',
 34 |             // 'phpmyadmin/private',
 35 |         ],
 36 |         // Token scopes: read_api
 37 |         // See: https://salsa.debian.org/phpmyadmin-team/phpmyadmin/-/settings/access_tokens
 38 |         'gitlab.com' => [],
 39 |         'salsa.debian.org' => [
 40 |             'phpmyadmin-team/phpmyadmin',
 41 |             'phpmyadmin-team/twig-i18n-extension',
 42 |             'phpmyadmin-team/mariadb-mysql-kbs',
 43 |             'phpmyadmin-team/motranslator',
 44 |             'phpmyadmin-team/sql-parser',
 45 |             'phpmyadmin-team/shapefile',
 46 |             'phpmyadmin-team/tcpdf',
 47 |         ],
 48 |     ];
 49 | 
 50 |     private const IGNORE_WORDS = [
 51 |         'Translated using Weblate',
 52 |         'Merge branch ',
 53 |         'Merge remote-tracking branch ',
 54 |         'Update d/changelog',// Debian commits for debian/changelog
 55 |     ];
 56 | 
 57 |     /**
 58 |      * @var array{
 59 |      * type: "GitHub"|"GitLab", slug: string, data: array[] }
 60 |      * }[]
 61 |      */
 62 |     private array $commitsStorage = [];
 63 | 
 64 |     /**
 65 |      * @var array{
 66 |      * type: "GitHub"|"GitLab", slug: string, data: array[] }
 67 |      * }[]
 68 |      */
 69 |     private array $issuesStorage = [];
 70 | 
 71 |     private bool $quietMode = false;
 72 |     private ?DateTimeImmutable $startDate = null;
 73 |     private ?DateTimeImmutable $endDate = null;
 74 |     private ?string $outputJsonData = null;
 75 |     private mixed $outputRender = STDOUT;
 76 |     private string $monthMode = 'none';
 77 |     private string $outputMode = 'none';
 78 |     // Tilde expansion: https://unix.stackexchange.com/a/151852/155610
 79 |     private string $configFile = '~/.config/phpmyadmin';
 80 | 
 81 |     public function run(): void
 82 |     {
 83 |         $shortopts  = '';
 84 |         $shortopts .= 'qh'; // These options do not accept values
 85 | 
 86 |         $longopts  = [
 87 |             'output:',      // Required value
 88 |             'output-json:', // Required value
 89 |             'config:',      // Required value
 90 |             'month:',       // Required value
 91 |             'optional::',   // Optional value
 92 |             'start-date::', // Optional value
 93 |             'end-date::',   // Optional value
 94 |             'help',         // No value
 95 |             'quiet',        // No value
 96 |             'last-month',   // No value
 97 |             'current-month',// No value
 98 |             'next-month',   // No value
 99 |             'by-week',      // No value
100 |         ];
101 |         $options = getopt($shortopts, $longopts);
102 | 
103 |         $this->checkExtensions();
104 | 
105 |         if ($options === []) {
106 |             $this->printHelp();
107 |         }
108 | 
109 |         foreach ($options as $optionName => $optionValue) {
110 |             if ($optionName === 'help' || $optionName === 'h') {
111 |                 $this->printHelp();
112 |             }
113 | 
114 |             if ($optionName === 'last-month') {
115 |                 $this->monthMode = 'last';
116 |             }
117 | 
118 |             if ($optionName === 'current-month') {
119 |                 $this->monthMode = 'current';
120 |             }
121 | 
122 |             if ($optionName === 'next-month') {
123 |                 $this->monthMode = 'next';
124 |             }
125 | 
126 |             if ($optionName === 'next-month') {
127 |                 $this->monthMode = 'next';
128 |             }
129 | 
130 |             if ($optionName === 'month') {
131 |                 $this->monthMode = 'custom';
132 |                 $this->startDate = new DateTimeImmutable('@' . strtotime('first day of ' . $optionValue . ' UTC'));
133 |                 $this->endDate = new DateTimeImmutable('@' . strtotime('last day of ' . $optionValue . ' UTC'));
134 |             }
135 | 
136 |             if ($optionName === 'start-date') {
137 |                 $this->monthMode = 'custom';
138 |                 if ($optionValue === false) {
139 |                     $this->quitError('The option --start-date needs a value, use the equal sign.');
140 |                 }
141 |                 $this->startDate = new DateTimeImmutable($optionValue . 'T00:00:00Z');
142 |             }
143 | 
144 |             if ($optionName === 'end-date') {
145 |                 $this->monthMode = 'custom';
146 |                 if ($optionValue === false) {
147 |                     $this->quitError('The option --end-date needs a value, use the equal sign.');
148 |                 }
149 |                 $this->endDate = new DateTimeImmutable($optionValue . 'T23:59:59Z');
150 |             }
151 | 
152 |             if ($optionName === 'quiet' || $optionName === 'q') {
153 |                 $this->quietMode = true;
154 |             }
155 | 
156 |             if ($optionName === 'config') {
157 |                 $this->configFile = $optionValue;
158 |             }
159 | 
160 |             if ($optionName === 'output') {
161 |                 $this->outputRender = $optionValue;
162 |             }
163 | 
164 |             if ($optionName === 'by-week') {
165 |                 $this->outputMode = 'by-week';
166 |             }
167 | 
168 |             if ($optionName !== 'output-json') {
169 |                 continue;
170 |             }
171 | 
172 |             $this->outputJsonData = $optionValue;
173 |         }
174 | 
175 |         if ($this->monthMode === 'none') {
176 |             $this->quitError('You need to specify a month mode, using cli: --{current,last,next}-month');
177 |         }
178 | 
179 |         $this->configFile = $this->expandTilde($this->configFile);
180 |         $this->detectCheckConfig();
181 |         $this->loadDates();
182 | 
183 |         $this->readConfig();
184 |         $this->printFinalData();
185 |         $this->renderFinalData();
186 |     }
187 | 
188 |     /**
189 |      * @source https://compwright.com/2013-09-03/tilde-expansion-in-php/
190 |      */
191 |     private function expandTilde(string $path): string
192 |     {
193 |         if (function_exists('posix_getuid') && strpos($path, '~') !== false) {
194 |             $info = posix_getpwuid(posix_getuid());
195 | 
196 |             return str_replace('~', $info['dir'], $path);
197 |         }
198 | 
199 |         return $path;
200 |     }
201 | 
202 |     private function printHelp(): void
203 |     {
204 |         fwrite(STDOUT, 'Usage:' . "\n");
205 |         fwrite(STDOUT, '  Help: ./phpmyadmin-report.php -h' . "\n");
206 |         fwrite(STDOUT, '  Help: ./phpmyadmin-report.php --help' . "\n");
207 |         fwrite(STDOUT, '  Turn off debug: ./phpmyadmin-report.php --quiet' . "\n");
208 |         fwrite(STDOUT, '  Turn off debug: ./phpmyadmin-report.php -q' . "\n");
209 |         fwrite(STDOUT, '  Custom config: ./phpmyadmin-report.php --config /home/user/report-config.conf' . "\n");
210 |         fwrite(STDOUT, '  Custom output: ./phpmyadmin-report.php --output /home/user/report-output.md' . "\n");
211 |         fwrite(STDOUT, '  Store json data: ./phpmyadmin-report.php --output-json /home/user/report-data.json' . "\n");
212 |         fwrite(STDOUT, '  Last month: ./phpmyadmin-report.php --last-month' . "\n");
213 |         fwrite(STDOUT, '  Current month: ./phpmyadmin-report.php --current-month' . "\n");
214 |         fwrite(STDOUT, '  Current month (by week): ./phpmyadmin-report.sh --current-month --by-week' . "\n");
215 |         fwrite(STDOUT, '  Next month: ./phpmyadmin-report.php --next-month' . "\n");
216 |         fwrite(STDOUT, '  Specific month: ./phpmyadmin-report.php --month October' . "\n");
217 |         fwrite(STDOUT, '  Custom dates: ./phpmyadmin-report.php --start-date=2021-05-03 --end-date=2021-06-27' . "\n");
218 |         exit(0);
219 |     }
220 | 
221 |     private function checkExt(string $extName): void
222 |     {
223 |         if (extension_loaded($extName)) {
224 |             return;
225 |         }
226 | 
227 |         $this->quitError($extName . ' could not be found');
228 |     }
229 | 
230 |     private function quitError(string $message, int $exitCode = 1): void
231 |     {
232 |         fwrite(STDERR, "\033[0;31m[ERROR] " . $message . "\033[0m" . "\n");
233 |         exit($exitCode);
234 |     }
235 | 
236 |     private function logDebug(string $message): void
237 |     {
238 |         if ($this->quietMode) {
239 |             return;
240 |         }
241 | 
242 |         fwrite(STDERR, "\033[1;35m[DEBUG] " . $message . "\033[0m" . "\n");
243 |     }
244 | 
245 |     private function logInfo(string $message): void
246 |     {
247 |         if ($this->quietMode) {
248 |             return;
249 |         }
250 | 
251 |         fwrite(STDERR, "\033[1;35m[INFO] ${message}\033[0m" . "\n");
252 |     }
253 | 
254 |     private function checkExtensions(): void
255 |     {
256 |         $this->checkExt('curl');
257 |     }
258 | 
259 |     private function detectCheckConfig(): void
260 |     {
261 |         if (file_exists($this->configFile)) {
262 |             return;
263 |         }
264 | 
265 |         $this->quitError('Missing config file at: ' . $this->configFile);
266 |     }
267 | 
268 |     private function readConfig(): void
269 |     {
270 |         $config = parse_ini_file(
271 |             $this->configFile,
272 |             true,
273 |             INI_SCANNER_NORMAL
274 |         );
275 | 
276 |         foreach ($config as $configBlockName => $configBlock) {
277 |             $this->processConfigBlock($configBlock, $configBlockName);
278 |         }
279 |     }
280 | 
281 |     private function getGitLabHost(?string $host): string
282 |     {
283 |         if ($host === null || $host === '') {
284 |             return 'gitlab.com';
285 |         }
286 | 
287 |         return $host;
288 |     }
289 | 
290 |     private function processConfigBlock(array $configBlockIn, string $configBlockName): void
291 |     {
292 |         $typeOrName = $configBlockIn['type'] ?? $configBlockName ?? '?';
293 | 
294 |         if ($typeOrName === 'gitlab') {
295 |             $this->processGitLab($configBlockIn);
296 |         } elseif ($typeOrName === 'github') {
297 |             $this->processGitHub($configBlockIn);
298 |         }
299 |     }
300 | 
301 |     private function processGitLab(array $configBlockIn): void
302 |     {
303 |         $this->logDebug('Processing GitLab projects...');
304 | 
305 |         $host = $this->getGitLabHost($configBlockIn['host'] ?? null);
306 | 
307 |         foreach (self::PROJECTS[$host] ?? [] as $projectSlug) {
308 |             $this->processGitLabProject($configBlockIn, $projectSlug);
309 |         }
310 | 
311 |         $this->logDebug('Processing GitLab projects done.');
312 |     }
313 | 
314 |     private function processGitHub(array $configBlockIn): void
315 |     {
316 |         $this->logDebug('Processing GitHub projects...');
317 | 
318 |         $host = 'github.com';
319 |         foreach (self::PROJECTS[$host] as $projectSlug) {
320 |             $this->processGitHubProject($configBlockIn, $projectSlug);
321 |         }
322 | 
323 |         $this->logDebug('Processing GitHub projects done.');
324 |     }
325 | 
326 |     private function callApi(string $url, array $requestHeaders): array
327 |     {
328 |         $ch = curl_init();
329 |         curl_setopt($ch, CURLOPT_URL, $url);
330 |         curl_setopt($ch, CURLOPT_USERAGENT, 'phpMyAdmin/reporting-script');
331 |         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
332 |         curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);
333 | 
334 |         $data = curl_exec($ch);
335 |         if ($data === false) {
336 |             $this->quitError(
337 |                 'Error while fetching: ' . $url . ' (' . curl_error($ch) . ')'
338 |             );
339 |         }
340 | 
341 |         $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
342 | 
343 |         curl_close($ch);
344 | 
345 |         if (! in_array($httpCode, [200, 201, 202])) {
346 |             $this->quitError(
347 |                 'Error code (' . $httpCode . ') from: ' . $url . ' -> ' . $data
348 |             );
349 |         }
350 | 
351 |         $jsonData = json_decode($data, true);
352 |         if (! is_array($jsonData)) {
353 |             $this->quitError(
354 |                 'Error data from: ' . $url . ' -> ' . $data
355 |             );
356 |         }
357 | 
358 |         return $jsonData;
359 |     }
360 | 
361 |     private function callGitHubApi(array $configBlockIn, string $path): array
362 |     {
363 |         $token = $configBlockIn['token'];
364 | 
365 |         $data = $this->callApi(
366 |             'https://api.github.com/' . $path,
367 |             [
368 |                 'Authorization: token ' . $token,
369 |                 'Accept: application/vnd.github+json',
370 |             ]
371 |         );
372 | 
373 |         if ($data['message'] ?? false) {
374 |             $this->quitError('GitHub API (' . $path . ') error: ' . $data['message']);
375 |         }
376 | 
377 |         return $data;
378 |     }
379 | 
380 |     private function callGitLabApi(array $configBlockIn, string $path): array
381 |     {
382 |         $token = $configBlockIn['token'];
383 |         $host = $configBlockIn['host'];
384 | 
385 |         $data = $this->callApi('https://' . $host . '/api/' . $path, ['Authorization: Bearer ' . $token]);
386 | 
387 |         if ($data['error'] ?? false) {
388 |             $this->quitError('GitLab (' . $host . ') API (' . $path . ') error (' . $data['error'] . ') : ' . $data['error_description']);
389 |         }
390 | 
391 |         return $data;
392 |     }
393 | 
394 |     private function processGitLabProject(array $configBlockIn, string $projectSlug): void
395 |     {
396 |         $projectSlugUrl = urlencode($projectSlug);
397 |         $authorEmail = $configBlockIn['authorEmail'];
398 |         $this->logDebug('Processing GitLab project: ' . $projectSlug);
399 |         $startDate = $this->startDate->format('Y-m-d\TH:i:sp');
400 |         $endDate = $this->endDate->format('Y-m-d\TH:i:sp');
401 |         $commits = $this->callGitLabApi(
402 |             $configBlockIn,
403 |             "v4/projects/${projectSlugUrl}/repository/commits?since=${startDate}&until=${endDate}"
404 |         );
405 | 
406 |         $commits = array_filter($commits, static function (array $commit) use ($authorEmail): bool {
407 |             return $commit['author_email'] === $authorEmail;
408 |         });
409 |         $this->gitLabCommitsToStorage($commits, $projectSlug);
410 |     }
411 | 
412 |     private function processGitHubProject(array $configBlockIn, string $projectSlug): void
413 |     {
414 |         $username = $configBlockIn['user'];
415 |         $this->logDebug('Processing GitHub project: ' . $projectSlug);
416 |         $startDate = $this->startDate->format('Y-m-d\TH:i:sp');
417 |         $endDate = $this->endDate->format('Y-m-d\TH:i:sp');
418 |         $commits = $this->callGitHubApi(
419 |             $configBlockIn,
420 |             "repos/${projectSlug}/commits?author=${username}&per_page=100&since=${startDate}&until=${endDate}"
421 |         );
422 | 
423 |         $this->gitHubCommitsToStorage($commits, $projectSlug);
424 | 
425 |         $issues = $this->callGitHubApi(
426 |             $configBlockIn,
427 |             "repos/${projectSlug}/issues?assignee=${username}&per_page=100&since=${startDate}&sort=updated&direction=asc&state=closed"
428 |         );
429 | 
430 |         $this->gitHubIssuesToStorage($issues, $projectSlug);
431 |     }
432 | 
433 |     private function gitHubIssuesToStorage(array $issues, string $projectSlug): void
434 |     {
435 |         $issues = array_filter($issues, static function (array $issue): bool {
436 |             return isset($issue['pull_request']) === false;
437 |         });
438 | 
439 |         $issues = array_filter($issues, function (array $issue): bool {
440 |             $cat = new DateTimeImmutable($issue['closed_at']);
441 | 
442 |             return $cat >= $this->startDate && $cat <= $this->endDate;
443 |         });
444 | 
445 |         $this->issuesStorage[] = [
446 |             'slug' => $projectSlug,
447 |             'type' => 'GitHub',
448 |             'issues' => array_map(static function (array $issue): array {
449 |                 return [
450 |                     'number' => $issue['number'],
451 |                     'title' => $issue['title'],
452 |                     'html_url' => $issue['html_url'],
453 |                     'closed_at' => new DateTimeImmutable($issue['closed_at']),
454 |                 ];
455 |             }, $issues),
456 |         ];
457 |     }
458 | 
459 |     private function gitHubCommitsToStorage(array $commits, string $projectSlug): void
460 |     {
461 |         $this->commitsStorage[] = [
462 |             'slug' => $projectSlug,
463 |             'type' => 'GitHub',
464 |             'commits' => array_map(static function (array $commit): array {
465 |                 return [
466 |                     'sha' => $commit['sha'],
467 |                     'message' => explode("\n", $commit['commit']['message'], 2)[0] ?? $commit['commit']['message'],
468 |                     'html_url' => $commit['html_url'],
469 |                     'cdate' => new DateTimeImmutable($commit['commit']['committer']['date']),
470 |                 ];
471 |             }, $commits),
472 |         ];
473 |     }
474 | 
475 |     private function gitLabCommitsToStorage(array $commits, string $projectSlug): void
476 |     {
477 |         $this->commitsStorage[] = [
478 |             'slug' => $projectSlug,
479 |             'type' => 'GitLab',
480 |             'commits' => array_map(static function (array $commit): array {
481 |                 return [
482 |                     'sha' => $commit['id'],
483 |                     'message' => $commit['title'],
484 |                     'html_url' => $commit['web_url'],
485 |                     'cdate' => new DateTimeImmutable($commit['committed_date']),
486 |                 ];
487 |             }, $commits),
488 |         ];
489 |     }
490 | 
491 |     private function printFinalData(): void
492 |     {
493 |         if ($this->outputJsonData === null) {
494 |             return;
495 |         }
496 | 
497 |         $this->logDebug('Commits data count: ' . count($this->commitsStorage));
498 |         $this->logDebug('Issues data count: ' . count($this->issuesStorage));
499 |         file_put_contents(
500 |             $this->outputJsonData,
501 |             json_encode([
502 |                 'commits' => $this->commitsStorage,
503 |                 'issues' => $this->issuesStorage,
504 |             ], JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
505 |         );
506 |     }
507 | 
508 |     private function printData(string $data): void
509 |     {
510 |         fwrite($this->outputRender, $data);
511 |     }
512 | 
513 |     private function renderFinalData(): void
514 |     {
515 |         $this->printData('# Commit list' . "\n");
516 | 
517 |         foreach ($this->commitsStorage as $storageEntry) {
518 |             if ($storageEntry['commits'] === []) {
519 |                 continue;
520 |             }
521 | 
522 |             // remove some commits base on commit body
523 |             foreach (self::IGNORE_WORDS as $ignoreWord) {
524 |                 $storageEntry['commits'] = array_filter(
525 |                     $storageEntry['commits'],
526 |                     static fn ($commit) => str_contains($commit['message'], $ignoreWord) === false
527 |                 );
528 |             }
529 | 
530 |             if ($storageEntry['commits'] === []) {
531 |                 continue;
532 |             }
533 | 
534 |             if ($this->outputMode === 'by-week') {
535 |                 $commitsGroup = array_reduce($storageEntry['commits'], static function (array $accumulator, array $element) {
536 |                     $accumulator[$element['cdate']->format('W')][] = $element;
537 | 
538 |                     return $accumulator;
539 |                 }, []);
540 |                 ksort($commitsGroup);// newer weeks first
541 | 
542 |                 $this->printData(sprintf("\n## %s (%s)\n", $storageEntry['slug'], $storageEntry['type']));
543 | 
544 |                 foreach ($commitsGroup as $monthNumber => $commits) {
545 |                     $this->printData(sprintf("\n### Week %s\n\n", $monthNumber));
546 |                     foreach ($commits as $commit) {
547 |                         $this->processCommit($commit);
548 |                     }
549 |                 }
550 | 
551 |                 continue;
552 |             }
553 | 
554 |             $this->printData(sprintf("\n## %s (%s)\n\n", $storageEntry['slug'], $storageEntry['type']));
555 | 
556 |             foreach ($storageEntry['commits'] as $commit) {
557 |                 $this->processCommit($commit);
558 |             }
559 |         }
560 | 
561 |         $this->printData("\n" . '# Handled issues' . "\n");
562 | 
563 |         foreach ($this->issuesStorage as $storageEntry) {
564 |             if ($storageEntry['issues'] === []) {
565 |                 continue;
566 |             }
567 | 
568 |             if ($this->outputMode === 'by-week') {
569 |                 $issuesGroup = array_reduce($storageEntry['issues'], static function (array $accumulator, array $element) {
570 |                     $accumulator[$element['closed_at']->format('W')][] = $element;
571 | 
572 |                     return $accumulator;
573 |                 }, []);
574 |                 ksort($issuesGroup);// newer weeks first
575 | 
576 |                 $this->printData(sprintf("\n## %s (%s)\n", $storageEntry['slug'], $storageEntry['type']));
577 | 
578 |                 foreach ($issuesGroup as $monthNumber => $issues) {
579 |                     $this->printData(sprintf("\n### Week %s\n\n", $monthNumber));
580 |                     foreach ($issues as $commit) {
581 |                         $this->processIssue($commit);
582 |                     }
583 |                 }
584 | 
585 |                 continue;
586 |             }
587 | 
588 |             $this->printData(sprintf("\n## %s (%s)\n\n", $storageEntry['slug'], $storageEntry['type']));
589 | 
590 |             foreach ($storageEntry['issues'] as $commit) {
591 |                 $this->processIssue($commit);
592 |             }
593 |         }
594 |     }
595 | 
596 |     private function processIssue(array $issue): void
597 |     {
598 |         $this->printData(
599 |             sprintf(
600 |                 '- [%s - %s](%s)' . "\n",
601 |                 $issue['number'],
602 |                 $issue['title'],
603 |                 $issue['html_url']
604 |             )
605 |         );
606 |     }
607 | 
608 |     private function processCommit(array $commit): void
609 |     {
610 |         $this->printData(
611 |             sprintf(
612 |                 '- [%s - %s](%s)' . "\n",
613 |                 substr($commit['sha'], 0, 10),
614 |                 $commit['message'],
615 |                 $commit['html_url']
616 |             )
617 |         );
618 |     }
619 | 
620 |     private function loadDates(): void
621 |     {
622 |         $this->logDebug('Using month mode: ' . $this->monthMode);
623 | 
624 |         // Source: http://databobjr.blogspot.com/2011/06/get-first-and-last-day-of-month-in-bash.html
625 | 
626 |         // Dates use format: YYYY-MM-DDTHH:MM:SSZ
627 | 
628 |         if ($this->monthMode === 'last') {
629 |             // Example (current date: 04/july(07)/2021 23:27): 2021-06-01T00:00:00Z
630 |             $this->startDate = new DateTimeImmutable('@' . strtotime('first day of last month UTC'));
631 |             // Example (current date: 04/july(07)/2021 23:27): 2021-06-30T00:00:00Z
632 |             $this->endDate = new DateTimeImmutable('@' . strtotime('last day of last month UTC'));
633 |         }
634 | 
635 |         if ($this->monthMode === 'current') {
636 |             // Example (current date: 04/july(07)/2021 23:27): 2021-07-01T00:00:00Z
637 |             $this->startDate = new DateTimeImmutable('@' . strtotime('first day of this month UTC'));
638 |             // Example (current date: 04/july(07)/2021 23:27): 2021-07-31T00:00:00Z
639 |             $this->endDate = new DateTimeImmutable('@' . strtotime('last day of this month UTC'));
640 |         }
641 | 
642 |         if ($this->monthMode === 'next') {
643 |             // Example (current date: 04/july(07)/2021 23:27): 2021-08-01T00:00:00Z
644 |             $this->startDate = new DateTimeImmutable('@' . strtotime('first day of next month UTC'));
645 |             // Example (current date: 04/july(07)/2021 23:27): 2021-08-31T00:00:00Z
646 |             $this->endDate = new DateTimeImmutable('@' . strtotime('last day of next month UTC'));
647 |         }
648 | 
649 |         $this->startDate = $this->startDate->setTimezone(new DateTimeZone('UTC'));
650 |         $this->startDate = $this->startDate->setTime(00, 00, 00);
651 |         $this->endDate = $this->endDate->setTimezone(new DateTimeZone('UTC'));
652 |         $this->endDate = $this->endDate->setTime(23, 59, 59);
653 | 
654 |         $this->logDebug('Start date (Y-m-d H:i:s): ' . $this->startDate->format('Y-m-d H:i:s'));
655 |         $this->logDebug('End date (Y-m-d H:i:s): ' . $this->endDate->format('Y-m-d H:i:s'));
656 |     }
657 | }
658 | 
659 | (new Reports())->run();
660 | 


--------------------------------------------------------------------------------
/demo/sql/sakila-db/sakila-schema.sql:
--------------------------------------------------------------------------------
  1 | -- Sakila Sample Database Schema
  2 | -- Version 0.8
  3 | 
  4 | -- Copyright (c) 2006, MySQL AB
  5 | -- All rights reserved.
  6 | 
  7 | -- Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
  8 | 
  9 | --  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 10 | --  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 11 | --  * Neither the name of MySQL AB nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 12 | 
 13 | -- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 14 | 
 15 | 
 16 | SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0;
 17 | SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0;
 18 | SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='TRADITIONAL';
 19 | 
 20 | DROP SCHEMA IF EXISTS sakila;
 21 | CREATE SCHEMA sakila;
 22 | USE sakila;
 23 | 
 24 | --
 25 | -- Table structure for table `actor`
 26 | --
 27 | 
 28 | CREATE TABLE actor (
 29 |   actor_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,
 30 |   first_name VARCHAR(45) NOT NULL,
 31 |   last_name VARCHAR(45) NOT NULL,
 32 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 33 |   PRIMARY KEY  (actor_id),
 34 |   KEY idx_actor_last_name (last_name)
 35 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
 36 | 
 37 | --
 38 | -- Table structure for table `address`
 39 | --
 40 | 
 41 | CREATE TABLE address (
 42 |   address_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,
 43 |   address VARCHAR(50) NOT NULL,
 44 |   address2 VARCHAR(50) DEFAULT NULL,
 45 |   district VARCHAR(20) NOT NULL,
 46 |   city_id SMALLINT UNSIGNED NOT NULL,
 47 |   postal_code VARCHAR(10) DEFAULT NULL,
 48 |   phone VARCHAR(20) NOT NULL,
 49 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 50 |   PRIMARY KEY  (address_id),
 51 |   KEY idx_fk_city_id (city_id),
 52 |   CONSTRAINT `fk_address_city` FOREIGN KEY (city_id) REFERENCES city (city_id) ON DELETE RESTRICT ON UPDATE CASCADE
 53 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
 54 | 
 55 | --
 56 | -- Table structure for table `category`
 57 | --
 58 | 
 59 | CREATE TABLE category (
 60 |   category_id TINYINT UNSIGNED NOT NULL AUTO_INCREMENT,
 61 |   name VARCHAR(25) NOT NULL,
 62 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 63 |   PRIMARY KEY  (category_id)
 64 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
 65 | 
 66 | --
 67 | -- Table structure for table `city`
 68 | --
 69 | 
 70 | CREATE TABLE city (
 71 |   city_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,
 72 |   city VARCHAR(50) NOT NULL,
 73 |   country_id SMALLINT UNSIGNED NOT NULL,
 74 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 75 |   PRIMARY KEY  (city_id),
 76 |   KEY idx_fk_country_id (country_id),
 77 |   CONSTRAINT `fk_city_country` FOREIGN KEY (country_id) REFERENCES country (country_id) ON DELETE RESTRICT ON UPDATE CASCADE
 78 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
 79 | 
 80 | --
 81 | -- Table structure for table `country`
 82 | --
 83 | 
 84 | CREATE TABLE country (
 85 |   country_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,
 86 |   country VARCHAR(50) NOT NULL,
 87 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 88 |   PRIMARY KEY  (country_id)
 89 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
 90 | 
 91 | --
 92 | -- Table structure for table `customer`
 93 | --
 94 | 
 95 | CREATE TABLE customer (
 96 |   customer_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,
 97 |   store_id TINYINT UNSIGNED NOT NULL,
 98 |   first_name VARCHAR(45) NOT NULL,
 99 |   last_name VARCHAR(45) NOT NULL,
100 |   email VARCHAR(50) DEFAULT NULL,
101 |   address_id SMALLINT UNSIGNED NOT NULL,
102 |   active BOOLEAN NOT NULL DEFAULT TRUE,
103 |   create_date DATETIME NOT NULL,
104 |   last_update TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
105 |   PRIMARY KEY  (customer_id),
106 |   KEY idx_fk_store_id (store_id),
107 |   KEY idx_fk_address_id (address_id),
108 |   KEY idx_last_name (last_name),
109 |   CONSTRAINT fk_customer_address FOREIGN KEY (address_id) REFERENCES address (address_id) ON DELETE RESTRICT ON UPDATE CASCADE,
110 |   CONSTRAINT fk_customer_store FOREIGN KEY (store_id) REFERENCES store (store_id) ON DELETE RESTRICT ON UPDATE CASCADE
111 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
112 | 
113 | --
114 | -- Table structure for table `film`
115 | --
116 | 
117 | CREATE TABLE film (
118 |   film_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,
119 |   title VARCHAR(255) NOT NULL,
120 |   description TEXT DEFAULT NULL,
121 |   release_year YEAR DEFAULT NULL,
122 |   language_id TINYINT UNSIGNED NOT NULL,
123 |   original_language_id TINYINT UNSIGNED DEFAULT NULL,
124 |   rental_duration TINYINT UNSIGNED NOT NULL DEFAULT 3,
125 |   rental_rate DECIMAL(4,2) NOT NULL DEFAULT 4.99,
126 |   length SMALLINT UNSIGNED DEFAULT NULL,
127 |   replacement_cost DECIMAL(5,2) NOT NULL DEFAULT 19.99,
128 |   rating ENUM('G','PG','PG-13','R','NC-17') DEFAULT 'G',
129 |   special_features SET('Trailers','Commentaries','Deleted Scenes','Behind the Scenes') DEFAULT NULL,
130 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
131 |   PRIMARY KEY  (film_id),
132 |   KEY idx_title (title),
133 |   KEY idx_fk_language_id (language_id),
134 |   KEY idx_fk_original_language_id (original_language_id),
135 |   CONSTRAINT fk_film_language FOREIGN KEY (language_id) REFERENCES language (language_id) ON DELETE RESTRICT ON UPDATE CASCADE,
136 |   CONSTRAINT fk_film_language_original FOREIGN KEY (original_language_id) REFERENCES language (language_id) ON DELETE RESTRICT ON UPDATE CASCADE
137 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
138 | 
139 | --
140 | -- Table structure for table `film_actor`
141 | --
142 | 
143 | CREATE TABLE film_actor (
144 |   actor_id SMALLINT UNSIGNED NOT NULL,
145 |   film_id SMALLINT UNSIGNED NOT NULL,
146 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
147 |   PRIMARY KEY  (actor_id,film_id),
148 |   KEY idx_fk_film_id (`film_id`),
149 |   CONSTRAINT fk_film_actor_actor FOREIGN KEY (actor_id) REFERENCES actor (actor_id) ON DELETE RESTRICT ON UPDATE CASCADE,
150 |   CONSTRAINT fk_film_actor_film FOREIGN KEY (film_id) REFERENCES film (film_id) ON DELETE RESTRICT ON UPDATE CASCADE
151 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
152 | 
153 | --
154 | -- Table structure for table `film_category`
155 | --
156 | 
157 | CREATE TABLE film_category (
158 |   film_id SMALLINT UNSIGNED NOT NULL,
159 |   category_id TINYINT UNSIGNED NOT NULL,
160 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
161 |   PRIMARY KEY (film_id, category_id),
162 |   CONSTRAINT fk_film_category_film FOREIGN KEY (film_id) REFERENCES film (film_id) ON DELETE RESTRICT ON UPDATE CASCADE,
163 |   CONSTRAINT fk_film_category_category FOREIGN KEY (category_id) REFERENCES category (category_id) ON DELETE RESTRICT ON UPDATE CASCADE
164 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
165 | 
166 | --
167 | -- Table structure for table `film_text`
168 | --
169 | 
170 | CREATE TABLE film_text (
171 |   film_id SMALLINT NOT NULL,
172 |   title VARCHAR(255) NOT NULL,
173 |   description TEXT,
174 |   PRIMARY KEY  (film_id),
175 |   FULLTEXT KEY idx_title_description (title,description)
176 | )ENGINE=MyISAM DEFAULT CHARSET=utf8;
177 | 
178 | 
179 | DELIMITER ;;
180 | CREATE TRIGGER `ins_film` AFTER INSERT ON `film` FOR EACH ROW BEGIN
181 |     INSERT INTO film_text (film_id, title, description)
182 |         VALUES (new.film_id, new.title, new.description);
183 |   END;;
184 | 
185 | 
186 | CREATE TRIGGER `upd_film` AFTER UPDATE ON `film` FOR EACH ROW BEGIN
187 |     IF (old.title != new.title) or (old.description != new.description)
188 |     THEN
189 |         UPDATE film_text
190 |             SET title=new.title,
191 |                 description=new.description,
192 |                 film_id=new.film_id
193 |         WHERE film_id=old.film_id;
194 |     END IF;
195 |   END;;
196 | 
197 | 
198 | CREATE TRIGGER `del_film` AFTER DELETE ON `film` FOR EACH ROW BEGIN
199 |     DELETE FROM film_text WHERE film_id = old.film_id;
200 |   END;;
201 | 
202 | DELIMITER ;
203 | 
204 | --
205 | -- Table structure for table `inventory`
206 | --
207 | 
208 | CREATE TABLE inventory (
209 |   inventory_id MEDIUMINT UNSIGNED NOT NULL AUTO_INCREMENT,
210 |   film_id SMALLINT UNSIGNED NOT NULL,
211 |   store_id TINYINT UNSIGNED NOT NULL,
212 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
213 |   PRIMARY KEY  (inventory_id),
214 |   KEY idx_fk_film_id (film_id),
215 |   KEY idx_store_id_film_id (store_id,film_id),
216 |   CONSTRAINT fk_inventory_store FOREIGN KEY (store_id) REFERENCES store (store_id) ON DELETE RESTRICT ON UPDATE CASCADE,
217 |   CONSTRAINT fk_inventory_film FOREIGN KEY (film_id) REFERENCES film (film_id) ON DELETE RESTRICT ON UPDATE CASCADE
218 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
219 | 
220 | --
221 | -- Table structure for table `language`
222 | --
223 | 
224 | CREATE TABLE language (
225 |   language_id TINYINT UNSIGNED NOT NULL AUTO_INCREMENT,
226 |   name CHAR(20) NOT NULL,
227 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
228 |   PRIMARY KEY (language_id)
229 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
230 | 
231 | --
232 | -- Table structure for table `payment`
233 | --
234 | 
235 | CREATE TABLE payment (
236 |   payment_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,
237 |   customer_id SMALLINT UNSIGNED NOT NULL,
238 |   staff_id TINYINT UNSIGNED NOT NULL,
239 |   rental_id INT DEFAULT NULL,
240 |   amount DECIMAL(5,2) NOT NULL,
241 |   payment_date DATETIME NOT NULL,
242 |   last_update TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
243 |   PRIMARY KEY  (payment_id),
244 |   KEY idx_fk_staff_id (staff_id),
245 |   KEY idx_fk_customer_id (customer_id),
246 |   CONSTRAINT fk_payment_rental FOREIGN KEY (rental_id) REFERENCES rental (rental_id) ON DELETE SET NULL ON UPDATE CASCADE,
247 |   CONSTRAINT fk_payment_customer FOREIGN KEY (customer_id) REFERENCES customer (customer_id) ON DELETE RESTRICT ON UPDATE CASCADE,
248 |   CONSTRAINT fk_payment_staff FOREIGN KEY (staff_id) REFERENCES staff (staff_id) ON DELETE RESTRICT ON UPDATE CASCADE
249 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
250 | 
251 | 
252 | --
253 | -- Table structure for table `rental`
254 | --
255 | 
256 | CREATE TABLE rental (
257 |   rental_id INT NOT NULL AUTO_INCREMENT,
258 |   rental_date DATETIME NOT NULL,
259 |   inventory_id MEDIUMINT UNSIGNED NOT NULL,
260 |   customer_id SMALLINT UNSIGNED NOT NULL,
261 |   return_date DATETIME DEFAULT NULL,
262 |   staff_id TINYINT UNSIGNED NOT NULL,
263 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
264 |   PRIMARY KEY (rental_id),
265 |   UNIQUE KEY  (rental_date,inventory_id,customer_id),
266 |   KEY idx_fk_inventory_id (inventory_id),
267 |   KEY idx_fk_customer_id (customer_id),
268 |   KEY idx_fk_staff_id (staff_id),
269 |   CONSTRAINT fk_rental_staff FOREIGN KEY (staff_id) REFERENCES staff (staff_id) ON DELETE RESTRICT ON UPDATE CASCADE,
270 |   CONSTRAINT fk_rental_inventory FOREIGN KEY (inventory_id) REFERENCES inventory (inventory_id) ON DELETE RESTRICT ON UPDATE CASCADE,
271 |   CONSTRAINT fk_rental_customer FOREIGN KEY (customer_id) REFERENCES customer (customer_id) ON DELETE RESTRICT ON UPDATE CASCADE
272 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
273 | 
274 | --
275 | -- Table structure for table `staff`
276 | --
277 | 
278 | CREATE TABLE staff (
279 |   staff_id TINYINT UNSIGNED NOT NULL AUTO_INCREMENT,
280 |   first_name VARCHAR(45) NOT NULL,
281 |   last_name VARCHAR(45) NOT NULL,
282 |   address_id SMALLINT UNSIGNED NOT NULL,
283 |   picture BLOB DEFAULT NULL,
284 |   email VARCHAR(50) DEFAULT NULL,
285 |   store_id TINYINT UNSIGNED NOT NULL,
286 |   active BOOLEAN NOT NULL DEFAULT TRUE,
287 |   username VARCHAR(16) NOT NULL,
288 |   password VARCHAR(40) BINARY DEFAULT NULL,
289 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
290 |   PRIMARY KEY  (staff_id),
291 |   KEY idx_fk_store_id (store_id),
292 |   KEY idx_fk_address_id (address_id),
293 |   CONSTRAINT fk_staff_store FOREIGN KEY (store_id) REFERENCES store (store_id) ON DELETE RESTRICT ON UPDATE CASCADE,
294 |   CONSTRAINT fk_staff_address FOREIGN KEY (address_id) REFERENCES address (address_id) ON DELETE RESTRICT ON UPDATE CASCADE
295 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
296 | 
297 | --
298 | -- Table structure for table `store`
299 | --
300 | 
301 | CREATE TABLE store (
302 |   store_id TINYINT UNSIGNED NOT NULL AUTO_INCREMENT,
303 |   manager_staff_id TINYINT UNSIGNED NOT NULL,
304 |   address_id SMALLINT UNSIGNED NOT NULL,
305 |   last_update TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
306 |   PRIMARY KEY  (store_id),
307 |   UNIQUE KEY idx_unique_manager (manager_staff_id),
308 |   KEY idx_fk_address_id (address_id),
309 |   CONSTRAINT fk_store_staff FOREIGN KEY (manager_staff_id) REFERENCES staff (staff_id) ON DELETE RESTRICT ON UPDATE CASCADE,
310 |   CONSTRAINT fk_store_address FOREIGN KEY (address_id) REFERENCES address (address_id) ON DELETE RESTRICT ON UPDATE CASCADE
311 | )ENGINE=InnoDB DEFAULT CHARSET=utf8;
312 | 
313 | --
314 | -- View structure for view `customer_list`
315 | --
316 | 
317 | CREATE VIEW customer_list 
318 | AS 
319 | SELECT cu.customer_id AS ID, CONCAT(cu.first_name, _utf8' ', cu.last_name) AS name, a.address AS address, a.postal_code AS `zip code`,
320 | 	a.phone AS phone, city.city AS city, country.country AS country, IF(cu.active, _utf8'active',_utf8'') AS notes, cu.store_id AS SID 
321 | FROM customer AS cu JOIN address AS a ON cu.address_id = a.address_id JOIN city ON a.city_id = city.city_id 
322 | 	JOIN country ON city.country_id = country.country_id;
323 | 
324 | --
325 | -- View structure for view `film_list`
326 | --
327 | 
328 | CREATE VIEW film_list 
329 | AS 
330 | SELECT film.film_id AS FID, film.title AS title, film.description AS description, category.name AS category, film.rental_rate AS price,
331 | 	film.length AS length, film.rating AS rating, GROUP_CONCAT(CONCAT(actor.first_name, _utf8' ', actor.last_name) SEPARATOR ', ') AS actors 
332 | FROM category LEFT JOIN film_category ON category.category_id = film_category.category_id LEFT JOIN film ON film_category.film_id = film.film_id
333 |         JOIN film_actor ON film.film_id = film_actor.film_id 
334 | 	JOIN actor ON film_actor.actor_id = actor.actor_id 
335 | GROUP BY film.film_id;
336 | 
337 | --
338 | -- View structure for view `nicer_but_slower_film_list`
339 | --
340 | 
341 | CREATE VIEW nicer_but_slower_film_list 
342 | AS 
343 | SELECT film.film_id AS FID, film.title AS title, film.description AS description, category.name AS category, film.rental_rate AS price, 
344 | 	film.length AS length, film.rating AS rating, GROUP_CONCAT(CONCAT(CONCAT(UCASE(SUBSTR(actor.first_name,1,1)),
345 | 	LCASE(SUBSTR(actor.first_name,2,LENGTH(actor.first_name))),_utf8' ',CONCAT(UCASE(SUBSTR(actor.last_name,1,1)),
346 | 	LCASE(SUBSTR(actor.last_name,2,LENGTH(actor.last_name)))))) SEPARATOR ', ') AS actors 
347 | FROM category LEFT JOIN film_category ON category.category_id = film_category.category_id LEFT JOIN film ON film_category.film_id = film.film_id
348 |         JOIN film_actor ON film.film_id = film_actor.film_id
349 | 	JOIN actor ON film_actor.actor_id = actor.actor_id 
350 | GROUP BY film.film_id;
351 | 
352 | --
353 | -- View structure for view `staff_list`
354 | --
355 | 
356 | CREATE VIEW staff_list 
357 | AS 
358 | SELECT s.staff_id AS ID, CONCAT(s.first_name, _utf8' ', s.last_name) AS name, a.address AS address, a.postal_code AS `zip code`, a.phone AS phone,
359 | 	city.city AS city, country.country AS country, s.store_id AS SID 
360 | FROM staff AS s JOIN address AS a ON s.address_id = a.address_id JOIN city ON a.city_id = city.city_id 
361 | 	JOIN country ON city.country_id = country.country_id;
362 | 
363 | --
364 | -- View structure for view `sales_by_store`
365 | --
366 | 
367 | CREATE VIEW sales_by_store
368 | AS 
369 | SELECT 
370 | CONCAT(c.city, _utf8',', cy.country) AS store
371 | , CONCAT(m.first_name, _utf8' ', m.last_name) AS manager
372 | , SUM(p.amount) AS total_sales
373 | FROM payment AS p
374 | INNER JOIN rental AS r ON p.rental_id = r.rental_id
375 | INNER JOIN inventory AS i ON r.inventory_id = i.inventory_id
376 | INNER JOIN store AS s ON i.store_id = s.store_id
377 | INNER JOIN address AS a ON s.address_id = a.address_id
378 | INNER JOIN city AS c ON a.city_id = c.city_id
379 | INNER JOIN country AS cy ON c.country_id = cy.country_id
380 | INNER JOIN staff AS m ON s.manager_staff_id = m.staff_id
381 | GROUP BY s.store_id
382 | ORDER BY cy.country, c.city;
383 | 
384 | --
385 | -- View structure for view `sales_by_film_category`
386 | --
387 | -- Note that total sales will add up to >100% because
388 | -- some titles belong to more than 1 category
389 | --
390 | 
391 | CREATE VIEW sales_by_film_category
392 | AS 
393 | SELECT 
394 | c.name AS category
395 | , SUM(p.amount) AS total_sales
396 | FROM payment AS p
397 | INNER JOIN rental AS r ON p.rental_id = r.rental_id
398 | INNER JOIN inventory AS i ON r.inventory_id = i.inventory_id
399 | INNER JOIN film AS f ON i.film_id = f.film_id
400 | INNER JOIN film_category AS fc ON f.film_id = fc.film_id
401 | INNER JOIN category AS c ON fc.category_id = c.category_id
402 | GROUP BY c.name
403 | ORDER BY total_sales DESC;
404 | 
405 | --
406 | -- View structure for view `actor_info`
407 | --
408 | 
409 | CREATE DEFINER=CURRENT_USER SQL SECURITY INVOKER VIEW actor_info 
410 | AS
411 | SELECT      
412 | a.actor_id,
413 | a.first_name,
414 | a.last_name,
415 | GROUP_CONCAT(DISTINCT CONCAT(c.name, ': ',
416 | 		(SELECT GROUP_CONCAT(f.title ORDER BY f.title SEPARATOR ', ')
417 |                     FROM sakila.film f
418 |                     INNER JOIN sakila.film_category fc
419 |                       ON f.film_id = fc.film_id
420 |                     INNER JOIN sakila.film_actor fa
421 |                       ON f.film_id = fa.film_id
422 |                     WHERE fc.category_id = c.category_id
423 |                     AND fa.actor_id = a.actor_id
424 |                  )
425 |              )
426 |              ORDER BY c.name SEPARATOR '; ')
427 | AS film_info
428 | FROM sakila.actor a
429 | LEFT JOIN sakila.film_actor fa
430 |   ON a.actor_id = fa.actor_id
431 | LEFT JOIN sakila.film_category fc
432 |   ON fa.film_id = fc.film_id
433 | LEFT JOIN sakila.category c
434 |   ON fc.category_id = c.category_id
435 | GROUP BY a.actor_id, a.first_name, a.last_name;
436 | 
437 | 
438 | DELIMITER //
439 | 
440 | CREATE PROCEDURE rewards_report (
441 |     IN min_monthly_purchases TINYINT UNSIGNED
442 |     , IN min_dollar_amount_purchased DECIMAL(10,2) UNSIGNED
443 |     , OUT count_rewardees INT
444 | )
445 | LANGUAGE SQL
446 | NOT DETERMINISTIC 
447 | READS SQL DATA
448 | SQL SECURITY DEFINER
449 | COMMENT 'Provides a customizable report on best customers'
450 | proc: BEGIN
451 |     
452 |     DECLARE last_month_start DATE;
453 |     DECLARE last_month_end DATE;
454 | 
455 |     /* Some sanity checks... */
456 |     IF min_monthly_purchases = 0 THEN
457 |         SELECT 'Minimum monthly purchases parameter must be > 0';
458 |         LEAVE proc;
459 |     END IF;
460 |     IF min_dollar_amount_purchased = 0.00 THEN
461 |         SELECT 'Minimum monthly dollar amount purchased parameter must be > $0.00';
462 |         LEAVE proc;
463 |     END IF;
464 | 
465 |     /* Determine start and end time periods */
466 |     SET last_month_start = DATE_SUB(CURRENT_DATE(), INTERVAL 1 MONTH);
467 |     SET last_month_start = STR_TO_DATE(CONCAT(YEAR(last_month_start),'-',MONTH(last_month_start),'-01'),'%Y-%m-%d');
468 |     SET last_month_end = LAST_DAY(last_month_start);
469 | 
470 |     /* 
471 |         Create a temporary storage area for 
472 |         Customer IDs.  
473 |     */
474 |     CREATE TEMPORARY TABLE tmpCustomer (customer_id SMALLINT UNSIGNED NOT NULL PRIMARY KEY);
475 | 
476 |     /* 
477 |         Find all customers meeting the 
478 |         monthly purchase requirements
479 |     */
480 |     INSERT INTO tmpCustomer (customer_id)
481 |     SELECT p.customer_id 
482 |     FROM payment AS p
483 |     WHERE DATE(p.payment_date) BETWEEN last_month_start AND last_month_end
484 |     GROUP BY customer_id
485 |     HAVING SUM(p.amount) > min_dollar_amount_purchased
486 |     AND COUNT(customer_id) > min_monthly_purchases;
487 | 
488 |     /* Populate OUT parameter with count of found customers */
489 |     SELECT COUNT(*) FROM tmpCustomer INTO count_rewardees;
490 | 
491 |     /* 
492 |         Output ALL customer information of matching rewardees.
493 |         Customize output as needed.
494 |     */
495 |     SELECT c.* 
496 |     FROM tmpCustomer AS t   
497 |     INNER JOIN customer AS c ON t.customer_id = c.customer_id;
498 | 
499 |     /* Clean up */
500 |     DROP TABLE tmpCustomer;
501 | END //
502 | 
503 | DELIMITER ;
504 | 
505 | DELIMITER $$
506 | 
507 | CREATE FUNCTION get_customer_balance(p_customer_id INT, p_effective_date DATETIME) RETURNS DECIMAL(5,2)
508 |     DETERMINISTIC
509 |     READS SQL DATA
510 | BEGIN
511 | 
512 |        #OK, WE NEED TO CALCULATE THE CURRENT BALANCE GIVEN A CUSTOMER_ID AND A DATE
513 |        #THAT WE WANT THE BALANCE TO BE EFFECTIVE FOR. THE BALANCE IS:
514 |        #   1) RENTAL FEES FOR ALL PREVIOUS RENTALS
515 |        #   2) ONE DOLLAR FOR EVERY DAY THE PREVIOUS RENTALS ARE OVERDUE
516 |        #   3) IF A FILM IS MORE THAN RENTAL_DURATION * 2 OVERDUE, CHARGE THE REPLACEMENT_COST
517 |        #   4) SUBTRACT ALL PAYMENTS MADE BEFORE THE DATE SPECIFIED
518 | 
519 |   DECLARE v_rentfees DECIMAL(5,2); #FEES PAID TO RENT THE VIDEOS INITIALLY
520 |   DECLARE v_overfees INTEGER;      #LATE FEES FOR PRIOR RENTALS
521 |   DECLARE v_payments DECIMAL(5,2); #SUM OF PAYMENTS MADE PREVIOUSLY
522 | 
523 |   SELECT IFNULL(SUM(film.rental_rate),0) INTO v_rentfees
524 |     FROM film, inventory, rental
525 |     WHERE film.film_id = inventory.film_id
526 |       AND inventory.inventory_id = rental.inventory_id
527 |       AND rental.rental_date <= p_effective_date
528 |       AND rental.customer_id = p_customer_id;
529 | 
530 |   SELECT IFNULL(SUM(IF((TO_DAYS(rental.return_date) - TO_DAYS(rental.rental_date)) > film.rental_duration,
531 |         ((TO_DAYS(rental.return_date) - TO_DAYS(rental.rental_date)) - film.rental_duration),0)),0) INTO v_overfees
532 |     FROM rental, inventory, film
533 |     WHERE film.film_id = inventory.film_id
534 |       AND inventory.inventory_id = rental.inventory_id
535 |       AND rental.rental_date <= p_effective_date
536 |       AND rental.customer_id = p_customer_id;
537 | 
538 | 
539 |   SELECT IFNULL(SUM(payment.amount),0) INTO v_payments
540 |     FROM payment
541 | 
542 |     WHERE payment.payment_date <= p_effective_date
543 |     AND payment.customer_id = p_customer_id;
544 | 
545 |   RETURN v_rentfees + v_overfees - v_payments;
546 | END $$
547 | 
548 | DELIMITER ;
549 | 
550 | DELIMITER $$
551 | 
552 | CREATE PROCEDURE film_in_stock(IN p_film_id INT, IN p_store_id INT, OUT p_film_count INT)
553 | READS SQL DATA
554 | BEGIN
555 |      SELECT inventory_id
556 |      FROM inventory
557 |      WHERE film_id = p_film_id
558 |      AND store_id = p_store_id
559 |      AND inventory_in_stock(inventory_id);
560 | 
561 |      SELECT FOUND_ROWS() INTO p_film_count;
562 | END $$
563 | 
564 | DELIMITER ;
565 | 
566 | DELIMITER $$
567 | 
568 | CREATE PROCEDURE film_not_in_stock(IN p_film_id INT, IN p_store_id INT, OUT p_film_count INT)
569 | READS SQL DATA
570 | BEGIN
571 |      SELECT inventory_id
572 |      FROM inventory
573 |      WHERE film_id = p_film_id
574 |      AND store_id = p_store_id
575 |      AND NOT inventory_in_stock(inventory_id);
576 | 
577 |      SELECT FOUND_ROWS() INTO p_film_count;
578 | END $$
579 | 
580 | DELIMITER ;
581 | 
582 | DELIMITER $$
583 | 
584 | CREATE FUNCTION inventory_held_by_customer(p_inventory_id INT) RETURNS INT
585 | READS SQL DATA
586 | BEGIN
587 |   DECLARE v_customer_id INT;
588 |   DECLARE EXIT HANDLER FOR NOT FOUND RETURN NULL;
589 | 
590 |   SELECT customer_id INTO v_customer_id
591 |   FROM rental
592 |   WHERE return_date IS NULL
593 |   AND inventory_id = p_inventory_id;
594 | 
595 |   RETURN v_customer_id;
596 | END $$
597 | 
598 | DELIMITER ;
599 | 
600 | DELIMITER $$
601 | 
602 | CREATE FUNCTION inventory_in_stock(p_inventory_id INT) RETURNS BOOLEAN
603 | READS SQL DATA
604 | BEGIN
605 |     DECLARE v_rentals INT;
606 |     DECLARE v_out     INT;
607 | 
608 |     #AN ITEM IS IN-STOCK IF THERE ARE EITHER NO ROWS IN THE rental TABLE
609 |     #FOR THE ITEM OR ALL ROWS HAVE return_date POPULATED
610 | 
611 |     SELECT COUNT(*) INTO v_rentals
612 |     FROM rental
613 |     WHERE inventory_id = p_inventory_id;
614 | 
615 |     IF v_rentals = 0 THEN
616 |       RETURN TRUE;
617 |     END IF;
618 | 
619 |     SELECT COUNT(rental_id) INTO v_out
620 |     FROM inventory LEFT JOIN rental USING(inventory_id)
621 |     WHERE inventory.inventory_id = p_inventory_id
622 |     AND rental.return_date IS NULL;
623 | 
624 |     IF v_out > 0 THEN
625 |       RETURN FALSE;
626 |     ELSE
627 |       RETURN TRUE;
628 |     END IF;
629 | END $$
630 | 
631 | DELIMITER ;
632 | 
633 | SET SQL_MODE=@OLD_SQL_MODE;
634 | SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS;
635 | SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS;
636 | 
637 | 
638 | 


--------------------------------------------------------------------------------