3 ## Take an existing, tar-based CiviCRM directory and convert it to a git working directory
7 ###########################################
8 ## usage: do_gitify <repo-url> <existing-dir> [git-checkout-options]
15 if [ -d "$TGT/.git" ]; then
16 echo "[[Already checked out git repo ($TGT) -- skip $REPO]]"
19 [ -d $TGT ] || mkdir
-p "$TGT"
20 [ -d $TMP ] && rm -rf "$TMP"
21 echo "[[Checkout $REPO ($TMP)]]"
22 echo "[git clone "$@
" "$REPO" "$TMP"]"
23 git clone
"$@" "$REPO" "$TMP"
25 echo "[[Swap metadata]]"
26 mv "$TMP/.git" "$TGT/.git"
28 echo "[[Remove local modifications]]"
29 pushd "$TGT" > /dev
/null
36 ###########################################
37 ## add hook shims to a repo
38 ## usage: do_hookify <canonical-repo-name> <repo-path> <relative-hook-path>
39 function do_hookify
() {
40 GIT_CANONICAL_REPO_NAME
="$1"
43 if [ -n "$CIVICRM_GIT_HOOKS" ]; then
44 echo "[[Install recommended hooks ($TGT)]]"
45 for HOOK
in commit-msg post-checkout post-merge pre-commit prepare-commit-msg post-commit pre-rebase post-rewrite
;do
46 cat << TMPL > "$TGT/.git/hooks/$HOOK"
48 if [ -f "\$GIT_DIR/${HOOK_DIR}/${HOOK}" ]; then
49 ## Note: GIT_CANONICAL_REPO_NAME was not provided by early hook-stubs
50 export GIT_CANONICAL_REPO_NAME="$GIT_CANONICAL_REPO_NAME"
51 source "\$GIT_DIR/${HOOK_DIR}/${HOOK}"
54 chmod +x
"$TGT/.git/hooks/$HOOK"
57 echo "[[Skip hook installation ($TGT) -- use \"--hooks\" to enable]]"
61 ###########################################
62 ## Create or update the URL of a git remote
63 ## usage: git_set_remote <local-repo-path> <remote-name> <remote-url>
64 function git_set_remote
() {
68 echo "[[Set remote ($REMOTE_NAME => $REMOTE_URL within $REPODIR)]]"
70 pushd "$REPODIR" >> /dev
/null
71 git remote set-url
"$REMOTE_NAME" "$REMOTE_URL" >/dev
/null
2>&1 || git remote add
"$REMOTE_NAME" "$REMOTE_URL"
75 ###########################################
76 ## usage: do_targzify <targz-url> <file-name> <existing-dir>
77 ## Fetches a tar.gz archive and unpacks it in the current directory
78 function do_targzify
() {
84 if [ -d "$TGT" ]; then
85 echo "[[Already have a copy of the archive ($TGT) -- skip $TARGZURL]]"
91 echo "[[Downloading $TARGZURL ($TMP)]]"
92 echo "[wget \"$TARGZURL\" -O \"$TMP/$TARFILE\"]"
94 pushd "$CIVICRM_ROOT" > /dev
/null
95 wget
-q "$TARGZURL" -O "$TMP/$TARFILE"
96 tar zxfv
"$TMP/$TARFILE"
103 ###########################################
104 ## usage: do_gencode <civicrm-path>
105 function do_gencode
() {
106 pushd "$1/xml" > /dev
/null
107 if [ -f "GenCode.php" ]; then
108 echo "[[Generate files]]"
111 echo "[[Skip \"Generate files\"]]"
116 ## usage: do_setupconf <civicrm-path>
117 function do_setupconf
() {
118 pushd "$1" >> /dev
/null
119 echo "[[Initialize bin/setup.conf]]"
120 if [ ! -f "bin/setup.conf" ]; then
122 echo cp "bin/setup.conf.txt" "bin/setup.conf"
123 cp "bin/setup.conf.txt" "bin/setup.conf"
125 echo "[[chmod 600 bin/setup.conf]]"
126 chmod 600 bin
/setup.conf
128 echo "====================[ Next steps (for Civi v4.6+) ]===================="
129 echo " * Edit the following file and fill in credentials for the CiviCRM DB."
130 echo " $1/bin/setup.conf"
131 echo " * Perform one of these steps:"
132 echo " + Run 'bin/setup.sh -Dg' to download and generate missing code."
133 echo " + Run 'bin/setup.sh' to download code and reset the CiviCRM DB"
134 echo " with the latest schema."
135 echo " * If this is a network-accessible server (eg staging/production), then"
136 echo " setup.conf may present a security issue. The permissions have been"
137 echo " preset to restrict access in most servers - but this may not work"
138 echo " in all environments. Please:"
139 echo " + Check whether the file is web-accessible."
140 echo " + Optionally, change the permissions."
141 echo " + Optionally, delete the file."
145 ###########################################
146 ## config_repo <repo-name> <local-path> <default-branch> <git-scripts-path>
148 function config_repo
() {
149 do_gitify
"${UPSTREAM_GIT_BASE_URL}/${1}.git" "$2" -b "$3"
150 do_hookify
"$1" "$2" "$4"
151 ## doesn't work with http -- git ls-remote "git://github.com/civicrm/civicrm-drupalz.git" HEAD --exit-code &>- ; echo $?
152 if [ -n "$FORK_GIT_BASE_URL" ]; then
153 git_set_remote
"$2" upstream
"${UPSTREAM_GIT_BASE_URL}/${1}.git"
154 git_set_remote
"$2" origin
"${FORK_GIT_BASE_URL}/${1}.git"
156 git_set_remote
"$2" origin
"${UPSTREAM_GIT_BASE_URL}/${1}.git"
160 function check_dep
() {
161 if [ -z "`which git`" ]; then
162 echo "command not found: git"
165 if [ -z `which php` ]; then
166 echo "command not found: php"
170 ###########################################
171 #### Main: Parse arguments
179 CIVICRM_BRANCH
="master"
181 UPSTREAM_GIT_BASE_URL
="https://github.com/civicrm"
184 while [ -n "$1" ]; do
185 if [ "$1" == "--l10n" ]; then
187 elif [ "$1" == "--hooks" ]; then
188 CIVICRM_GIT_HOOKS
="$1"
189 elif [ "$1" == "--upstream" ]; then
191 UPSTREAM_GIT_BASE_URL
="$1"
192 elif [ "$1" == "--fork" ]; then
194 FORK_GIT_BASE_URL
="$1"
195 elif [ "$1" == "--skip-gencode" ]; then
197 elif [ "$1" == "--branch" ]; then
200 elif [ -z "$CIVICRM_CMS" ]; then
203 elif [ -z "$CIVICRM_ROOT" ]; then
207 echo "unrecognized argument: $1"
213 if [ -z "$CIVICRM_ROOT" -o ! -d "$CIVICRM_ROOT" -o -z "$UPSTREAM_GIT_BASE_URL" -o -z "$CIVICRM_CMS" ]; then
214 echo "Convert a directory into a set of CiviCRM git clones"
215 echo "usage: $0 <Drupal|Drupal6|Joomla|WordPress|all> <existing-civicrm-root> [--fork <base-url>] [--upstream <base-url>] [--l10n] [--hooks] [--branch <branch>]"
216 echo " <cms-name>: one of: Drupal|Drupal6|Joomla|WordPress|all"
217 echo " <git-base-url>: a base URL shared by the desiried git repos (e.g. git://github.com/civicrm)"
218 echo " <existing-civicrm-root>: the main directory containing CiviCRM"
219 echo " --upstream <base-url>: specify the base URL for upstream repositories"
220 echo " --fork <base-url>: specify the base URL for your personal fork repositories"
221 echo " --l10n: optionally fetch localization data"
222 echo " --hooks: optionally install recommended git hooks; the hooks are mostly"
223 echo " tested with git CLI under Linux and OSX; they haven't been"
224 echo " tested with git GUIs or Windows"
225 echo " --branch <branch>: specy the base branch name to checkout (ex: 'master', '4.4')"
226 echo " For some repos, this name is adapted (ex: Drupal's '7.x-master' or '6.x-master'"
227 echo " --skip-gencode: optionally disable gencode execution"
229 echo "Note: If pointing to a pre-existing directory, your local changes may be replaced by"
230 echo "the pristine code from git. If you've made changes, then make sure there's a backup!"
232 echo "example: $0 Drupal /var/www/drupal7/sites/all/modules/civicrm"
233 echo " (checkout core code plus Drupal 7.x integration code)"
235 echo "example: $0 Drupal6 /var/www/drupal6/sites/all/modules/civicrm"
236 echo " (checkout core code plus Drupal 6.x integration code)"
238 echo "example: $0 all ~/src/civicrm --upstream git@github.com:civicrm --l10n"
239 echo " (checkout core code plus Drupal 7.x, Joomla, and WordPress integration code and l10n using SSH)"
243 ###########################################
244 #### Main: Update git repo metadata ####
247 ## config_repo <repo-name> <local-path> <default-branch> <git-scripts-path>
248 config_repo civicrm-core
"$CIVICRM_ROOT" "$CIVICRM_BRANCH" "../tools/scripts/git"
249 config_repo civicrm-packages
"$CIVICRM_ROOT/packages" "$CIVICRM_BRANCH" "../../tools/scripts/git"
250 case "$CIVICRM_CMS" in
252 config_repo civicrm-drupal
"$CIVICRM_ROOT/drupal" "7.x-$CIVICRM_BRANCH" "../../tools/scripts/git"
255 config_repo civicrm-drupal
"$CIVICRM_ROOT/drupal" "6.x-$CIVICRM_BRANCH" "../../tools/scripts/git"
258 config_repo civicrm-joomla
"$CIVICRM_ROOT/joomla" "$CIVICRM_BRANCH" "../../tools/scripts/git"
261 config_repo civicrm-wordpress
"$CIVICRM_ROOT/WordPress" "$CIVICRM_BRANCH" "../../tools/scripts/git"
264 config_repo civicrm-drupal
"$CIVICRM_ROOT/drupal" "7.x-$CIVICRM_BRANCH" "../../tools/scripts/git"
265 config_repo civicrm-joomla
"$CIVICRM_ROOT/joomla" "$CIVICRM_BRANCH" "../../tools/scripts/git"
266 config_repo civicrm-wordpress
"$CIVICRM_ROOT/WordPress" "$CIVICRM_BRANCH" "../../tools/scripts/git"
271 echo "Unrecognized CMS: $CIVICRM_CMS"
274 if [ "$CIVICRM_L10N" == "--l10n" ]; then
275 do_targzify
"https://download.civicrm.org/civicrm-l10n-core/archives/civicrm-l10n-daily.tar.gz" "civicrm-l10n-daily.tar.gz" "$CIVICRM_ROOT/l10n"
278 if [ -f "$CIVICRM_ROOT/composer.json" ]; then
280 do_setupconf
"$CIVICRM_ROOT"
281 elif [ -z "$SKIP_GENCODE" ]; then
282 do_gencode
"$CIVICRM_ROOT"