[civicrm-core.git] / distmaker / dists / common.sh

#!/bin/bash

## Delete/create a dir
## usage: dm_reset_dirs <path1> <path2> ...
function dm_reset_dirs() {
  for d in "$@" ; do
    [ -d "$d" ] && rm -rf "$d"
  done

  mkdir -p "$@"
}

## Assert that a folder contains no symlinks
##
## ex: dev/core#1393, dev/core#1990
## usage: dm_assert_no_symlinks <basedir>
function dm_assert_no_symlinks() {
  local SYMLINKS=$( find "$1" -type l )
  if [ -n "$SYMLINKS" ]; then
    echo "ERROR: Folder $1 contains unexpected symlink(s): $SYMLINKS"
    exit 10
  fi
}

## Copy files from one dir into another dir
## usage: dm_install_dir <from-dir> <to-dir>
function dm_install_dir() {
  local from="$1"
  local to="$2"

  if [ ! -d "$to" ]; then
    mkdir -p "$to"
  fi
  ${DM_RSYNC:-rsync} -avC --exclude=.git --exclude=.svn "$from/./"  "$to/./"
}

## Copy listed files
## usage: dm_install_files <from-dir> <to-dir> <file1> <file2>...
function dm_install_files() {
  local from="$1"
  shift
  local to="$1"
  shift

  for file in "$@" ; do
    [ -f "$from/$file" ] && cp -f "$from/$file" "$to/$file"
  done
}

## usage: dm_remove_files <directory> <file1> <file2>...
function dm_remove_files() {
  local tgt="$1"
  shift

  for file in "$@" ; do
    [ -f "$tgt/$file" -o -L "$tgt/$file" ] && rm -f "$tgt/$file"
  done
}

## Copy all bower dependencies
function dm_install_bower() {
  local repo="$1"
  local to="$2"

  local excludes_rsync=""
  for exclude in .git .svn {T,t}est{,s} {D,d}oc{,s} {E,e}xample{,s} ; do
    excludes_rsync="--exclude=${exclude} ${excludes_rsync}"
  done

  [ ! -d "$to" ] && mkdir "$to"
  ${DM_RSYNC:-rsync} -avC $excludes_rsync "$repo/./" "$to/./"
}

## Copy all core files
## usage: dm_install_core <core_repo_path> <to_path>
function dm_install_core() {
  local repo="$1"
  local to="$2"

  for dir in ang css i js PEAR templates bin CRM api extern Reports install settings Civi partials release-notes xml setup ; do
    [ -d "$repo/$dir" ] && dm_install_dir "$repo/$dir" "$to/$dir"
  done

  dm_install_files "$repo" "$to" {agpl-3.0,agpl-3.0.exception,gpl,CONTRIBUTORS}.txt
  dm_install_files "$repo" "$to" composer.json composer.lock package.json Civi.php README.md release-notes.md extension-compatibility.json

  mkdir -p "$to/sql"
  pushd "$repo" >> /dev/null
    dm_install_files "$repo" "$to" sql/civicrm*.mysql sql/case_sample*.mysql
    ## TODO: for master, remove counties.US.SQL.gz
  popd >> /dev/null

  if [ -d $to/bin ] ; then
    rm -f $to/bin/setup.sh
    rm -f $to/bin/setup.php4.sh
    rm -f $to/bin/setup.bat
  fi

  set +e
  rm -rf $to/sql/civicrm_*.??_??.mysql
  set -e
}

## Copy built-in extensions
## usage: dm_install_core <core_repo_path> <to_path> <ext-dirs...>
function dm_install_coreext() {
  local repo="$1"
  local to="$2"
  shift
  shift

  for relext in "$@" ; do
    [ ! -d "$to/ext/$relext" ] && mkdir -p "$to/ext/$relext"
    ${DM_RSYNC:-rsync} -avC $excludes_rsync --include=core "$repo/ext/$relext/./" "$to/ext/$relext/./"
  done
}

## Get a list of default/core extension directories (space-delimited)
## reldirs=$(dm_core_exts)
function dm_core_exts() {
  ## grep to exclude comments and blank lines
  grep '^[a-zA-Z]' "$DM_SOURCEDIR"/distmaker/core-ext.txt
}

## Copy all packages
## usage: dm_install_packages <packages_repo_path> <to_path>
function dm_install_packages() {
  local repo="$1"
  local to="$2"

  local excludes_rsync=""
  for exclude in .git .svn _ORIGINAL_ SeleniumRC PHPUnit PhpDocumentor SymfonyComponents git-footnote PHP/CodeCoverage ; do
    excludes_rsync="--exclude=${exclude} ${excludes_rsync}"
  done

  ## Note: These small folders have items that previously were not published,
  ## but there's no real cost to including them, and excluding them seems
  ## likely to cause confusion as the codebase evolves:
  ##   packages/Files packages/PHP packages/Text

  [ ! -d "$to" ] && mkdir "$to"
  ${DM_RSYNC:-rsync} -avC $excludes_rsync --include=core "$repo/./" "$to/./"
}

## Copy Drupal-integration module
## usage: dm_install_drupal <drupal_repo_path> <to_path>
function dm_install_drupal() {
  local repo="$1"
  local to="$2"
  dm_install_dir "$repo" "$to"

  # Set full version in .info files. See CRM-15768.
  local MODULE_DIRS=`find "$to" -type f -name "*.info"`
  for INFO in $MODULE_DIRS; do
    dm_preg_edit '/version = ([0-9]*\.x)-[1-9.]*/m' "version = \$1-$DM_VERSION" "$INFO"
  done

  for f in "$to/.gitignore" "$to/.toxic.json" ; do
    if [ -f "$f" ]; then
      rm -f "$f"
    fi
  done
}

## Copy Joomla-integration module
## usage: dm_install_joomla <joomla_repo_path> <to_path>
function dm_install_joomla() {
  local repo="$1"
  local to="$2"
  dm_install_dir "$repo" "$to"

  ## Before this change, the zip file included the joomla-integration
  ## modules twice. The two were basically identical -- except that
  ## one included .gitignore and the omitted it. We'll now omit it
  ## consistently.

  for f in "$to/.gitignore" "$to/.toxic.json" ; do
    if [ -f "$f" ]; then
      rm -f "$f"
    fi
  done
}

## usage: dm_install_l10n <l10n_repo_path> <to_path>
function dm_install_l10n() {
  local repo="$1"
  local to="$2"
  dm_install_dir "$repo" "$to"
}

## Copy composer's "vendor" folder
## usage: dm_install_vendor <from_path> <to_path>
function dm_install_vendor() {
  local repo="$1"
  local to="$2"

  local excludes_rsync=""
  ## CRM-21729 - .idea test-cases unit-test come from phpquery package.
  for exclude in .git .svn {T,t}est{,s} {D,d}oc{,s} {E,e}xample{,s} .idea test-cases unit-test README.rst; do
    excludes_rsync="--exclude=${exclude} ${excludes_rsync}"
  done

  [ ! -d "$to" ] && mkdir "$to"
  ${DM_RSYNC:-rsync} -avC $excludes_rsync "$repo/./" "$to/./"
  ## We don't this use CLI script in production, and the symlink breaks D7/BD URL installs
  dm_remove_files "$to" "bin/pscss" "bin/cssmin"
}

##  usage: dm_install_wordpress <wp_repo_path> <to_path>
function dm_install_wordpress() {
  local repo="$1"
  local to="$2"

  if [ ! -d "$to" ]; then
    mkdir -p "$to"
  fi
  ${DM_RSYNC:-rsync} -avC \
    --exclude=.git \
    --exclude=.svn \
    --exclude=civicrm.config.php.wordpress \
    --exclude=.toxic.json \
    --exclude=.gitignore \
    --exclude=civicrm \
    "$repo/./"  "$to/./"
  ## Need --exclude=civicrm for self-building on WP site

  dm_preg_edit '/^([ \*]*)Version: [0-9\.]+/m' "\1Version: $DM_VERSION" "$to/civicrm.php"
  dm_preg_edit "/^define\( *\'CIVICRM_PLUGIN_VERSION\', *'[0-9\.]+/m" "define('CIVICRM_PLUGIN_VERSION', '$DM_VERSION" "$to/civicrm.php"
}

## Generate the composer "vendor" folder
## usage: dm_generate_vendor <repo_path>
function dm_generate_vendor() {
  local repo="$1"
  pushd "$repo"
    ${DM_COMPOSER:-composer} install
  popd
}

## Generate civicrm-version.php
## usage: dm_generate_version <file> <ufname>
function dm_generate_version() {
  local to="$1"
  local ufname="$2"

  # final touch
  echo "<?php
/** @deprecated */
function civicrmVersion( ) {
  return array( 'version'  => '$DM_VERSION',
                'cms'      => '$ufname',
                'revision' => '$DM_REVISION' );
}
" > "$to"
}

## Perform a hard checkout on a given report
## usage: dm_git_checkout <repo_path> <tree-ish>
function dm_git_checkout() {
  pushd "$1"
    git checkout .
    git checkout "$2"
  popd
}

## Download a Civi extension
## usage: dm_install_cvext <full-ext-key> <target-path>
function dm_install_cvext() {
  # cv dl -b '@https://civicrm.org/extdir/ver=4.7.25|cms=Drupal/com.iatspayments.civicrm.xml' --destination=$PWD/iatspayments
  cv dl -b "@https://civicrm.org/extdir/ver=$DM_VERSION|cms=Drupal/$1.xml" --to="$2"
}

## Export a list of patch files from a git repo
## usage: dm_export_patches <src-repo> <out-dir> <range>
## ex: dm_export_patches "$HOME/src/somerepo" "/tmp/export" 5.1.2..5.1.6
function dm_export_patches() {
  if [ ! -d "$1" ]; then
    echo "ignore: $1"
    return
  fi
  echo "Export \"$1\" ($3) to \"$2\""
  pushd "$1" >> /dev/null
    git format-patch "$3" -o "$2"
  popd >> /dev/null
}


## Edit a file by applying a regular expression.
## Note: We'd rather just call "sed", but it differs on GNU+BSD.
## usage: dm_preg_edit <search-pattern> <replacement-pattern> <file>
## example: '/version = \([0-9]*\.x-\)[1-9.]*/' 'version = \1$DM_VERSION'
function dm_preg_edit() {
  env RPAT="$1" RREPL="$2" RFILE="$3" \
    php -r '$c = file_get_contents(getenv("RFILE")); $c = preg_replace(getenv("RPAT"), getenv("RREPL"), $c); file_put_contents(getenv("RFILE"), $c);'
}
Commit	Line	Data
69ff4a4a	1	#!/bin/bash
69ff4a4a	2
fa379693	3	## Delete/create a dir
	4	## usage: dm_reset_dirs <path1> <path2> ...
	5	function dm_reset_dirs() {
	6	for d in "$@" ; do
	7	[ -d "$d" ] && rm -rf "$d"
	8	done
	9
	10	mkdir -p "$@"
	11	}
	12
8a5f52de TO	13	## Assert that a folder contains no symlinks
	14	##
	15	## ex: dev/core#1393, dev/core#1990
	16	## usage: dm_assert_no_symlinks <basedir>
	17	function dm_assert_no_symlinks() {
	18	local SYMLINKS=$( find "$1" -type l )
	19	if [ -n "$SYMLINKS" ]; then
	20	echo "ERROR: Folder $1 contains unexpected symlink(s): $SYMLINKS"
	21	exit 10
	22	fi
	23	}
	24
69ff4a4a	25	## Copy files from one dir into another dir
	26	## usage: dm_install_dir <from-dir> <to-dir>
	27	function dm_install_dir() {
	28	local from="$1"
	29	local to="$2"
	30
	31	if [ ! -d "$to" ]; then
	32	mkdir -p "$to"
	33	fi
e00b8b13	34	${DM_RSYNC:-rsync} -avC --exclude=.git --exclude=.svn "$from/./" "$to/./"
69ff4a4a	35	}
	36
	37	## Copy listed files
	38	## usage: dm_install_files <from-dir> <to-dir> <file1> <file2>...
	39	function dm_install_files() {
	40	local from="$1"
	41	shift
	42	local to="$1"
	43	shift
	44
	45	for file in "$@" ; do
	46	[ -f "$from/$file" ] && cp -f "$from/$file" "$to/$file"
	47	done
	48	}
	49
	50	## usage: dm_remove_files <directory> <file1> <file2>...
	51	function dm_remove_files() {
	52	local tgt="$1"
	53	shift
	54
	55	for file in "$@" ; do
e0dcd057	56	[ -f "$tgt/$file" -o -L "$tgt/$file" ] && rm -f "$tgt/$file"
69ff4a4a	57	done
	58	}
	59
1446640b TO	60	## Copy all bower dependencies
	61	function dm_install_bower() {
	62	local repo="$1"
	63	local to="$2"
	64
	65	local excludes_rsync=""
	66	for exclude in .git .svn {T,t}est{,s} {D,d}oc{,s} {E,e}xample{,s} ; do
	67	excludes_rsync="--exclude=${exclude} ${excludes_rsync}"
	68	done
	69
	70	[ ! -d "$to" ] && mkdir "$to"
e00b8b13	71	${DM_RSYNC:-rsync} -avC $excludes_rsync "$repo/./" "$to/./"
1446640b TO	72	}
1446640b TO	73
69ff4a4a	74	## Copy all core files
	75	## usage: dm_install_core <core_repo_path> <to_path>
	76	function dm_install_core() {
	77	local repo="$1"
	78	local to="$2"
	79
784ab2f0	80	for dir in ang css i js PEAR templates bin CRM api extern Reports install settings Civi partials release-notes xml setup ; do
69ff4a4a	81	[ -d "$repo/$dir" ] && dm_install_dir "$repo/$dir" "$to/$dir"
	82	done
	83
62da8665	84	dm_install_files "$repo" "$to" {agpl-3.0,agpl-3.0.exception,gpl,CONTRIBUTORS}.txt
a8fadf7d	85	dm_install_files "$repo" "$to" composer.json composer.lock package.json Civi.php README.md release-notes.md extension-compatibility.json
69ff4a4a	86
	87	mkdir -p "$to/sql"
	88	pushd "$repo" >> /dev/null
61101c01	89	dm_install_files "$repo" "$to" sql/civicrm.mysql sql/case_sample.mysql
69ff4a4a	90	## TODO: for master, remove counties.US.SQL.gz
	91	popd >> /dev/null
	92
	93	if [ -d $to/bin ] ; then
	94	rm -f $to/bin/setup.sh
	95	rm -f $to/bin/setup.php4.sh
	96	rm -f $to/bin/setup.bat
	97	fi
	98
	99	set +e
	100	rm -rf $to/sql/civicrm_*.??_??.mysql
	101	set -e
	102	}
9f0ca23d	103
c4f1d7e4 TO	104	## Copy built-in extensions
	105	## usage: dm_install_core <core_repo_path> <to_path> <ext-dirs...>
	106	function dm_install_coreext() {
	107	local repo="$1"
	108	local to="$2"
	109	shift
	110	shift
	111
	112	for relext in "$@" ; do
3b53967d SL	113	[ ! -d "$to/ext/$relext" ] && mkdir -p "$to/ext/$relext"
3b53967d SL	114	${DM_RSYNC:-rsync} -avC $excludes_rsync --include=core "$repo/ext/$relext/./" "$to/ext/$relext/./"
c4f1d7e4 TO	115	done
	116	}
	117
	118	## Get a list of default/core extension directories (space-delimited)
	119	## reldirs=$(dm_core_exts)
	120	function dm_core_exts() {
cc058df6 TO	121	## grep to exclude comments and blank lines
cc058df6 TO	122	grep '^[a-zA-Z]' "$DM_SOURCEDIR"/distmaker/core-ext.txt
c4f1d7e4 TO	123	}
c4f1d7e4 TO	124
9f0ca23d	125	## Copy all packages
	126	## usage: dm_install_packages <packages_repo_path> <to_path>
	127	function dm_install_packages() {
	128	local repo="$1"
	129	local to="$2"
	130
	131	local excludes_rsync=""
4a0626d0	132	for exclude in .git .svn _ORIGINAL_ SeleniumRC PHPUnit PhpDocumentor SymfonyComponents git-footnote PHP/CodeCoverage ; do
9f0ca23d	133	excludes_rsync="--exclude=${exclude} ${excludes_rsync}"
	134	done
	135
e365b6e5	136	## Note: These small folders have items that previously were not published,
	137	## but there's no real cost to including them, and excluding them seems
	138	## likely to cause confusion as the codebase evolves:
	139	## packages/Files packages/PHP packages/Text
	140
9f0ca23d	141	[ ! -d "$to" ] && mkdir "$to"
e00b8b13	142	${DM_RSYNC:-rsync} -avC $excludes_rsync --include=core "$repo/./" "$to/./"
9f0ca23d	143	}
7082ee3c	144
	145	## Copy Drupal-integration module
	146	## usage: dm_install_drupal <drupal_repo_path> <to_path>
	147	function dm_install_drupal() {
	148	local repo="$1"
	149	local to="$2"
bf20507d	150	dm_install_dir "$repo" "$to"
7082ee3c	151
0c5cbe3d	152	# Set full version in .info files. See CRM-15768.
7082ee3c	153	local MODULE_DIRS=`find "$to" -type f -name "*.info"`
7082ee3c	154	for INFO in $MODULE_DIRS; do
065248bd	155	dm_preg_edit '/version = ([0-9]\.x)-[1-9.]/m' "version = \$1-$DM_VERSION" "$INFO"
7082ee3c	156	done
08297720 TO	157
	158	for f in "$to/.gitignore" "$to/.toxic.json" ; do
	159	if [ -f "$f" ]; then
	160	rm -f "$f"
	161	fi
	162	done
7082ee3c	163	}
30a50cd8	164
274ebc9e	165	## Copy Joomla-integration module
	166	## usage: dm_install_joomla <joomla_repo_path> <to_path>
	167	function dm_install_joomla() {
	168	local repo="$1"
	169	local to="$2"
bf20507d	170	dm_install_dir "$repo" "$to"
80def6a8	171
	172	## Before this change, the zip file included the joomla-integration
	173	## modules twice. The two were basically identical -- except that
	174	## one included .gitignore and the omitted it. We'll now omit it
	175	## consistently.
08297720 TO	176
	177	for f in "$to/.gitignore" "$to/.toxic.json" ; do
	178	if [ -f "$f" ]; then
	179	rm -f "$f"
	180	fi
	181	done
274ebc9e	182	}
274ebc9e	183
8d32d903	184	## usage: dm_install_l10n <l10n_repo_path> <to_path>
	185	function dm_install_l10n() {
	186	local repo="$1"
	187	local to="$2"
	188	dm_install_dir "$repo" "$to"
	189	}
	190
c84eb16e TO	191	## Copy composer's "vendor" folder
	192	## usage: dm_install_vendor <from_path> <to_path>
	193	function dm_install_vendor() {
	194	local repo="$1"
	195	local to="$2"
	196
	197	local excludes_rsync=""
af5c4d9f	198	## CRM-21729 - .idea test-cases unit-test come from phpquery package.
48cd94bb	199	for exclude in .git .svn {T,t}est{,s} {D,d}oc{,s} {E,e}xample{,s} .idea test-cases unit-test README.rst; do
c84eb16e TO	200	excludes_rsync="--exclude=${exclude} ${excludes_rsync}"
	201	done
	202
c84eb16e	203	[ ! -d "$to" ] && mkdir "$to"
e00b8b13	204	${DM_RSYNC:-rsync} -avC $excludes_rsync "$repo/./" "$to/./"
e0dcd057	205	## We don't this use CLI script in production, and the symlink breaks D7/BD URL installs
9c9e7406	206	dm_remove_files "$to" "bin/pscss" "bin/cssmin"
c84eb16e TO	207	}
c84eb16e TO	208
9003e8e1	209	## usage: dm_install_wordpress <wp_repo_path> <to_path>
	210	function dm_install_wordpress() {
	211	local repo="$1"
	212	local to="$2"
d0f95878	213
	214	if [ ! -d "$to" ]; then
	215	mkdir -p "$to"
	216	fi
e00b8b13	217	${DM_RSYNC:-rsync} -avC \
d0f95878	218	--exclude=.git \
	219	--exclude=.svn \
	220	--exclude=civicrm.config.php.wordpress \
08297720	221	--exclude=.toxic.json \
d0f95878	222	--exclude=.gitignore \
	223	--exclude=civicrm \
	224	"$repo/./" "$to/./"
	225	## Need --exclude=civicrm for self-building on WP site
006e39e1	226
cadf8ce2 TO	227	dm_preg_edit '/^([ \])Version: [0-9\.]+/m' "\1Version: $DM_VERSION" "$to/civicrm.php"
cadf8ce2 TO	228	dm_preg_edit "/^define\( \'CIVICRM_PLUGIN_VERSION\', '[0-9\.]+/m" "define('CIVICRM_PLUGIN_VERSION', '$DM_VERSION" "$to/civicrm.php"
9003e8e1	229	}
9003e8e1	230
c84eb16e TO	231	## Generate the composer "vendor" folder
	232	## usage: dm_generate_vendor <repo_path>
	233	function dm_generate_vendor() {
	234	local repo="$1"
	235	pushd "$repo"
1446640b	236	${DM_COMPOSER:-composer} install
c84eb16e TO	237	popd
	238	}
	239
30a50cd8	240	## Generate civicrm-version.php
	241	## usage: dm_generate_version <file> <ufname>
	242	function dm_generate_version() {
	243	local to="$1"
	244	local ufname="$2"
	245
	246	# final touch
	247	echo "<?php
e78d5446	248	/** @deprecated */
30a50cd8	249	function civicrmVersion( ) {
	250	return array( 'version' => '$DM_VERSION',
	251	'cms' => '$ufname',
	252	'revision' => '$DM_REVISION' );
	253	}
	254	" > "$to"
	255	}
445009ec	256
	257	## Perform a hard checkout on a given report
	258	## usage: dm_git_checkout <repo_path> <tree-ish>
	259	function dm_git_checkout() {
	260	pushd "$1"
	261	git checkout .
	262	git checkout "$2"
	263	popd
	264	}
006e39e1	265
3c7cc32e TO	266	## Download a Civi extension
	267	## usage: dm_install_cvext <full-ext-key> <target-path>
	268	function dm_install_cvext() {
	269	# cv dl -b '@https://civicrm.org/extdir/ver=4.7.25\|cms=Drupal/com.iatspayments.civicrm.xml' --destination=$PWD/iatspayments
	270	cv dl -b "@https://civicrm.org/extdir/ver=$DM_VERSION\|cms=Drupal/$1.xml" --to="$2"
	271	}
	272
cd0432e8	273	## Export a list of patch files from a git repo
22e9ee71	274	## usage: dm_export_patches <src-repo> <out-dir> <range>
cd0432e8	275	## ex: dm_export_patches "$HOME/src/somerepo" "/tmp/export" 5.1.2..5.1.6
22e9ee71 TO	276	function dm_export_patches() {
	277	if [ ! -d "$1" ]; then
	278	echo "ignore: $1"
	279	return
	280	fi
	281	echo "Export \"$1\" ($3) to \"$2\""
	282	pushd "$1" >> /dev/null
	283	git format-patch "$3" -o "$2"
	284	popd >> /dev/null
	285	}
	286
	287
006e39e1 TO	288	## Edit a file by applying a regular expression.
	289	## Note: We'd rather just call "sed", but it differs on GNU+BSD.
	290	## usage: dm_preg_edit <search-pattern> <replacement-pattern> <file>
	291	## example: '/version = \([0-9]\.x-\)[1-9.]/' 'version = \1$DM_VERSION'
	292	function dm_preg_edit() {
	293	env RPAT="$1" RREPL="$2" RFILE="$3" \
	294	php -r '$c = file_get_contents(getenv("RFILE")); $c = preg_replace(getenv("RPAT"), getenv("RREPL"), $c); file_put_contents(getenv("RFILE"), $c);'
	295	}