├── LICENSE
├── README.md
├── deploy-config.example.php
└── deploy.php


/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License
 2 | 
 3 | Copyright (c) 2013 Marko Markovic <okram (at) civokram (dot) com>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Simple PHP Git deploy script
 2 | _Automatically deploy the code using PHP and Git._
 3 | 
 4 | ## Requirements
 5 | 
 6 | * `git` and `rsync` are required on the server that's running the script
 7 |   (_server machine_).
 8 |   - Optionally, `tar` is required for backup functionality (`BACKUP_DIR` option).
 9 |   - Optionally, `composer` is required for composer functionality (`USE_COMPOSER`
10 |   option).
11 | * The system user running PHP (e.g. `www-data`) needs to have the necessary
12 |   access permissions for the `TMP_DIR` and `TARGET_DIR` locations on
13 |   the _server machine_.
14 | * If the Git repository you wish to deploy is private, the system user running PHP
15 |   also needs to have the right SSH keys to access the remote repository.
16 | 
17 | ## Usage
18 | 
19 |  * Configure the script and put it somewhere that's accessible from the
20 |    Internet. The preferred way to configure it is to use `deploy-config.php` file.
21 |    Rename `deploy-config.example.php` to `deploy-config.php` and edit the
22 |    configuration options there. That way, you won't have to edit the configuration
23 |    again if you download the new version of `deploy.php`.
24 |  * Configure your git repository to call this script when the code is updated.
25 |    The instructions for GitHub and Bitbucket are below.
26 | 
27 | ### GitHub
28 | 
29 |  1. _(This step is only needed for private repositories)_ Go to
30 |     `https://github.com/USERNAME/REPOSITORY/settings/keys` and add your server
31 |     SSH key.
32 |  1. Go to `https://github.com/USERNAME/REPOSITORY/settings/hooks`.
33 |  1. Click **Add webhook** in the **Webhooks** panel.
34 |  1. Enter the **Payload URL** for your deployment script e.g. `http://example.com/deploy.php?sat=YourSecretAccessTokenFromDeployFile`.
35 |  1. _Optional_ Choose which events should trigger the deployment.
36 |  1. Make sure that the **Active** checkbox is checked.
37 |  1. Click **Add webhook**.
38 | 
39 | ### Bitbucket
40 | 
41 |  1. _(This step is only needed for private repositories)_ Go to
42 |     `https://bitbucket.org/USERNAME/REPOSITORY/admin/deploy-keys` and add your
43 |     server SSH key.
44 |  1. Go to `https://bitbucket.org/USERNAME/REPOSITORY/admin/services`.
45 |  1. Add **POST** service.
46 |  1. Enter the URL to your deployment script e.g. `http://example.com/deploy.php?sat=YourSecretAccessTokenFromDeployFile`.
47 |  1. Click **Save**.
48 | 
49 | ### Generic Git
50 | 
51 |  1. Configure the SSH keys.
52 |  1. Add a executable `.git/hooks/post_receive` script that calls the script e.g.
53 | 
54 | ```sh
55 | #!/bin/sh
56 | echo "Triggering the code deployment ..."
57 | wget -q -O /dev/null http://example.com/deploy.php?sat=YourSecretAccessTokenFromDeployFile
58 | ```
59 | 
60 | ## Done!
61 | 
62 | Next time you push the code to the repository that has a hook enabled, it's
63 | going to trigger the `deploy.php` script which is going to pull the changes and
64 | update the code on the _server machine_.
65 | 
66 | For more info, read the source of `deploy.php`.
67 | 
68 | ## Tips'n'Tricks
69 | 
70 |  * Because `rsync` is used for deployment, the `TARGET_DIR` doesn't have to be
71 |    on the same server that the script is running e.g. `define('TARGET_DIR',
72 |    'username@example.com:/full/path/to/target_dir/');` is going to work as long
73 |    as the user has the right SSH keys and access permissions.
74 |  * You can have multiple scripts with different configurations. Simply rename
75 |    the `deploy.php` to something else, for example `deploy_master.php` and
76 |    `deploy_develop.php` and configure them separately. In that case, the
77 |    configuration files need to be named `deploy_master-config.php` and
78 |    `deploy_develop-config.php` respectively.
79 | 
80 | ---
81 | 
82 | If you find this script useful, consider donating BTC to `1fLnPZkMYw1TFNEsJZCciwDAmUhDw2wit`.
83 | 


--------------------------------------------------------------------------------
/deploy-config.example.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Deployment configuration
  4 |  *
  5 |  * It's preferable to configure the script using this file instead of directly.
  6 |  *
  7 |  * Rename this file to `deploy-config.php` and edit the
  8 |  * configuration options here instead of directly in `deploy.php`.
  9 |  * That way, you won't have to edit the configuration again if you download the
 10 |  * new version of `deploy.php`.
 11 |  *
 12 |  * @version 1.3.1
 13 |  */
 14 | 
 15 | /**
 16 |  * Protect the script from unauthorized access by using a secret access token.
 17 |  * If it's not present in the access URL as a GET variable named `sat`
 18 |  * e.g. deploy.php?sat=Bett...s the script is not going to deploy.
 19 |  *
 20 |  * @var string
 21 |  */
 22 | define('SECRET_ACCESS_TOKEN', 'BetterChangeMeNowOrSufferTheConsequences');
 23 | 
 24 | /**
 25 |  * The address of the remote Git repository that contains the code that's being
 26 |  * deployed.
 27 |  * If the repository is private, you'll need to use the SSH address.
 28 |  *
 29 |  * @var string
 30 |  */
 31 | define('REMOTE_REPOSITORY', 'https://github.com/markomarkovic/simple-php-git-deploy.git');
 32 | 
 33 | /**
 34 |  * The branch that's being deployed.
 35 |  * Must be present in the remote repository.
 36 |  *
 37 |  * @var string
 38 |  */
 39 | define('BRANCH', 'master');
 40 | 
 41 | /**
 42 |  * The location that the code is going to be deployed to.
 43 |  * Don't forget the trailing slash!
 44 |  *
 45 |  * @var string Full path including the trailing slash
 46 |  */
 47 | define('TARGET_DIR', '/tmp/simple-php-git-deploy/');
 48 | 
 49 | /**
 50 |  * Whether to delete the files that are not in the repository but are on the
 51 |  * local (server) machine.
 52 |  *
 53 |  * !!! WARNING !!! This can lead to a serious loss of data if you're not
 54 |  * careful. All files that are not in the repository are going to be deleted,
 55 |  * except the ones defined in EXCLUDE section.
 56 |  * BE CAREFUL!
 57 |  *
 58 |  * @var boolean
 59 |  */
 60 | define('DELETE_FILES', false);
 61 | 
 62 | /**
 63 |  * The directories and files that are to be excluded when updating the code.
 64 |  * Normally, these are the directories containing files that are not part of
 65 |  * code base, for example user uploads or server-specific configuration files.
 66 |  * Use rsync exclude pattern syntax for each element.
 67 |  *
 68 |  * @var serialized array of strings
 69 |  */
 70 | define('EXCLUDE', serialize(array(
 71 | 	'.git',
 72 | )));
 73 | 
 74 | /**
 75 |  * Temporary directory we'll use to stage the code before the update. If it
 76 |  * already exists, script assumes that it contains an already cloned copy of the
 77 |  * repository with the correct remote origin and only fetches changes instead of
 78 |  * cloning the entire thing.
 79 |  *
 80 |  * @var string Full path including the trailing slash
 81 |  */
 82 | define('TMP_DIR', '/tmp/spgd-'.md5(REMOTE_REPOSITORY).'/');
 83 | 
 84 | /**
 85 |  * Whether to remove the TMP_DIR after the deployment.
 86 |  * It's useful NOT to clean up in order to only fetch changes on the next
 87 |  * deployment.
 88 |  */
 89 | define('CLEAN_UP', true);
 90 | 
 91 | /**
 92 |  * Output the version of the deployed code.
 93 |  *
 94 |  * @var string Full path to the file name
 95 |  */
 96 | define('VERSION_FILE', TMP_DIR.'VERSION');
 97 | 
 98 | /**
 99 |  * Time limit for each command.
100 |  *
101 |  * @var int Time in seconds
102 |  */
103 | define('TIME_LIMIT', 30);
104 | 
105 | /**
106 |  * OPTIONAL
107 |  * Backup the TARGET_DIR into BACKUP_DIR before deployment.
108 |  *
109 |  * @var string Full backup directory path e.g. `/tmp/`
110 |  */
111 | define('BACKUP_DIR', false);
112 | 
113 | /**
114 |  * OPTIONAL
115 |  * Whether to invoke composer after the repository is cloned or changes are
116 |  * fetched. Composer needs to be available on the server machine, installed
117 |  * globaly (as `composer`). See http://getcomposer.org/doc/00-intro.md#globally
118 |  *
119 |  * @var boolean Whether to use composer or not
120 |  * @link http://getcomposer.org/
121 |  */
122 | define('USE_COMPOSER', false);
123 | 
124 | /**
125 |  * OPTIONAL
126 |  * The options that the composer is going to use.
127 |  *
128 |  * @var string Composer options
129 |  * @link http://getcomposer.org/doc/03-cli.md#install
130 |  */
131 | define('COMPOSER_OPTIONS', '--no-dev');
132 | 
133 | /**
134 |  * OPTIONAL
135 |  * The COMPOSER_HOME environment variable is needed only if the script is
136 |  * executed by a system user that has no HOME defined, e.g. `www-data`.
137 |  *
138 |  * @var string Path to the COMPOSER_HOME e.g. `/tmp/composer`
139 |  * @link https://getcomposer.org/doc/03-cli.md#composer-home
140 |  */
141 | define('COMPOSER_HOME', false);
142 | 
143 | /**
144 |  * OPTIONAL
145 |  * Email address to be notified on deployment failure.
146 |  *
147 |  * @var string A single email address, or comma separated list of email addresses
148 |  *      e.g. 'someone@example.com' or 'someone@example.com, someone-else@example.com, ...'
149 |  */
150 | define('EMAIL_ON_ERROR', false);
151 | 


--------------------------------------------------------------------------------
/deploy.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Simple PHP Git deploy script
  4 |  *
  5 |  * Automatically deploy the code using PHP and Git.
  6 |  *
  7 |  * @version 1.3.1
  8 |  * @link    https://github.com/markomarkovic/simple-php-git-deploy/
  9 |  */
 10 | 
 11 | // =========================================[ Configuration start ]===
 12 | 
 13 | /**
 14 |  * It's preferable to configure the script using `deploy-config.php` file.
 15 |  *
 16 |  * Rename `deploy-config.example.php` to `deploy-config.php` and edit the
 17 |  * configuration options there instead of here. That way, you won't have to edit
 18 |  * the configuration again if you download the new version of `deploy.php`.
 19 |  */
 20 | if (file_exists(basename(__FILE__, '.php').'-config.php')) {
 21 | 	define('CONFIG_FILE', basename(__FILE__, '.php').'-config.php');
 22 | 	require_once CONFIG_FILE;
 23 | } else {
 24 | 	define('CONFIG_FILE', __FILE__);
 25 | }
 26 | 
 27 | /**
 28 |  * Protect the script from unauthorized access by using a secret access token.
 29 |  * If it's not present in the access URL as a GET variable named `sat`
 30 |  * e.g. deploy.php?sat=Bett...s the script is not going to deploy.
 31 |  *
 32 |  * @var string
 33 |  */
 34 | if (!defined('SECRET_ACCESS_TOKEN')) define('SECRET_ACCESS_TOKEN', 'BetterChangeMeNowOrSufferTheConsequences');
 35 | 
 36 | /**
 37 |  * The address of the remote Git repository that contains the code that's being
 38 |  * deployed.
 39 |  * If the repository is private, you'll need to use the SSH address.
 40 |  *
 41 |  * @var string
 42 |  */
 43 | if (!defined('REMOTE_REPOSITORY')) define('REMOTE_REPOSITORY', 'https://github.com/markomarkovic/simple-php-git-deploy.git');
 44 | 
 45 | /**
 46 |  * The branch that's being deployed.
 47 |  * Must be present in the remote repository.
 48 |  *
 49 |  * @var string
 50 |  */
 51 | if (!defined('BRANCH')) define('BRANCH', 'master');
 52 | 
 53 | /**
 54 |  * The location that the code is going to be deployed to.
 55 |  * Don't forget the trailing slash!
 56 |  *
 57 |  * @var string Full path including the trailing slash
 58 |  */
 59 | if (!defined('TARGET_DIR')) define('TARGET_DIR', '/tmp/simple-php-git-deploy/');
 60 | 
 61 | /**
 62 |  * Whether to delete the files that are not in the repository but are on the
 63 |  * local (server) machine.
 64 |  *
 65 |  * !!! WARNING !!! This can lead to a serious loss of data if you're not
 66 |  * careful. All files that are not in the repository are going to be deleted,
 67 |  * except the ones defined in EXCLUDE section.
 68 |  * BE CAREFUL!
 69 |  *
 70 |  * @var boolean
 71 |  */
 72 | if (!defined('DELETE_FILES')) define('DELETE_FILES', false);
 73 | 
 74 | /**
 75 |  * The directories and files that are to be excluded when updating the code.
 76 |  * Normally, these are the directories containing files that are not part of
 77 |  * code base, for example user uploads or server-specific configuration files.
 78 |  * Use rsync exclude pattern syntax for each element.
 79 |  *
 80 |  * @var serialized array of strings
 81 |  */
 82 | if (!defined('EXCLUDE')) define('EXCLUDE', serialize(array(
 83 | 	'.git',
 84 | )));
 85 | 
 86 | /**
 87 |  * Temporary directory we'll use to stage the code before the update. If it
 88 |  * already exists, script assumes that it contains an already cloned copy of the
 89 |  * repository with the correct remote origin and only fetches changes instead of
 90 |  * cloning the entire thing.
 91 |  *
 92 |  * @var string Full path including the trailing slash
 93 |  */
 94 | if (!defined('TMP_DIR')) define('TMP_DIR', '/tmp/spgd-'.md5(REMOTE_REPOSITORY).'/');
 95 | 
 96 | /**
 97 |  * Whether to remove the TMP_DIR after the deployment.
 98 |  * It's useful NOT to clean up in order to only fetch changes on the next
 99 |  * deployment.
100 |  */
101 | if (!defined('CLEAN_UP')) define('CLEAN_UP', true);
102 | 
103 | /**
104 |  * Output the version of the deployed code.
105 |  *
106 |  * @var string Full path to the file name
107 |  */
108 | if (!defined('VERSION_FILE')) define('VERSION_FILE', TMP_DIR.'VERSION');
109 | 
110 | /**
111 |  * Time limit for each command.
112 |  *
113 |  * @var int Time in seconds
114 |  */
115 | if (!defined('TIME_LIMIT')) define('TIME_LIMIT', 30);
116 | 
117 | /**
118 |  * OPTIONAL
119 |  * Backup the TARGET_DIR into BACKUP_DIR before deployment.
120 |  *
121 |  * @var string Full backup directory path e.g. `/tmp/`
122 |  */
123 | if (!defined('BACKUP_DIR')) define('BACKUP_DIR', false);
124 | 
125 | /**
126 |  * OPTIONAL
127 |  * Whether to invoke composer after the repository is cloned or changes are
128 |  * fetched. Composer needs to be available on the server machine, installed
129 |  * globaly (as `composer`). See http://getcomposer.org/doc/00-intro.md#globally
130 |  *
131 |  * @var boolean Whether to use composer or not
132 |  * @link http://getcomposer.org/
133 |  */
134 | if (!defined('USE_COMPOSER')) define('USE_COMPOSER', false);
135 | 
136 | /**
137 |  * OPTIONAL
138 |  * The options that the composer is going to use.
139 |  *
140 |  * @var string Composer options
141 |  * @link http://getcomposer.org/doc/03-cli.md#install
142 |  */
143 | if (!defined('COMPOSER_OPTIONS')) define('COMPOSER_OPTIONS', '--no-dev');
144 | 
145 | /**
146 |  * OPTIONAL
147 |  * The COMPOSER_HOME environment variable is needed only if the script is
148 |  * executed by a system user that has no HOME defined, e.g. `www-data`.
149 |  *
150 |  * @var string Path to the COMPOSER_HOME e.g. `/tmp/composer`
151 |  * @link https://getcomposer.org/doc/03-cli.md#composer-home
152 |  */
153 | if (!defined('COMPOSER_HOME')) define('COMPOSER_HOME', false);
154 | 
155 | /**
156 |  * OPTIONAL
157 |  * Email address to be notified on deployment failure.
158 |  *
159 |  * @var string A single email address, or comma separated list of email addresses
160 |  *      e.g. 'someone@example.com' or 'someone@example.com, someone-else@example.com, ...'
161 |  */
162 | if (!defined('EMAIL_ON_ERROR')) define('EMAIL_ON_ERROR', false);
163 | 
164 | // ===========================================[ Configuration end ]===
165 | 
166 | // If there's authorization error, set the correct HTTP header.
167 | if (!isset($_GET['sat']) || $_GET['sat'] !== SECRET_ACCESS_TOKEN || SECRET_ACCESS_TOKEN === 'BetterChangeMeNowOrSufferTheConsequences') {
168 | 	header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden', true, 403);
169 | }
170 | ob_start();
171 | ?>
172 | <!DOCTYPE html>
173 | <html lang="en">
174 | <head>
175 | 	<meta charset="utf-8">
176 | 	<meta name="robots" content="noindex">
177 | 	<title>Simple PHP Git deploy script</title>
178 | 	<style>
179 | body { padding: 0 1em; background: #222; color: #fff; }
180 | h2, .error { color: #c33; }
181 | .prompt { color: #6be234; }
182 | .command { color: #729fcf; }
183 | .output { color: #999; }
184 | 	</style>
185 | </head>
186 | <body>
187 | <?php
188 | if (!isset($_GET['sat']) || $_GET['sat'] !== SECRET_ACCESS_TOKEN) {
189 | 	header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden', true, 403);
190 | 	die('<h2>ACCESS DENIED!</h2>');
191 | }
192 | if (SECRET_ACCESS_TOKEN === 'BetterChangeMeNowOrSufferTheConsequences') {
193 | 	header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden', true, 403);
194 | 	die("<h2>You're suffering the consequences!<br>Change the SECRET_ACCESS_TOKEN from it's default value!</h2>");
195 | }
196 | ?>
197 | <pre>
198 | 
199 | Checking the environment ...
200 | 
201 | Running as <b><?php echo trim(shell_exec('whoami')); ?></b>.
202 | 
203 | <?php
204 | // Check if the required programs are available
205 | $requiredBinaries = array('git', 'rsync');
206 | if (defined('BACKUP_DIR') && BACKUP_DIR !== false) {
207 | 	$requiredBinaries[] = 'tar';
208 | 	if (!is_dir(BACKUP_DIR) || !is_writable(BACKUP_DIR)) {
209 | 		header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error', true, 500);
210 | 		die(sprintf('<div class="error">BACKUP_DIR `%s` does not exists or is not writeable.</div>', BACKUP_DIR));
211 | 	}
212 | }
213 | if (defined('USE_COMPOSER') && USE_COMPOSER === true) {
214 | 	$requiredBinaries[] = 'composer --no-ansi';
215 | }
216 | foreach ($requiredBinaries as $command) {
217 | 	$path = trim(shell_exec('which '.$command));
218 | 	if ($path == '') {
219 | 		header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error', true, 500);
220 | 		die(sprintf('<div class="error"><b>%s</b> not available. It needs to be installed on the server for this script to work.</div>', $command));
221 | 	} else {
222 | 		$version = explode("\n", shell_exec($command.' --version'));
223 | 		printf('<b>%s</b> : %s'."\n"
224 | 			, $path
225 | 			, $version[0]
226 | 		);
227 | 	}
228 | }
229 | ?>
230 | 
231 | Environment OK.
232 | 
233 | Using configuration defined in <?php echo CONFIG_FILE."\n"; ?>
234 | 
235 | Deploying <?php echo REMOTE_REPOSITORY; ?> <?php echo BRANCH."\n"; ?>
236 | to        <?php echo TARGET_DIR; ?> ...
237 | 
238 | <?php
239 | // The commands
240 | $commands = array();
241 | 
242 | // ========================================[ Pre-Deployment steps ]===
243 | 
244 | if (!is_dir(TMP_DIR)) {
245 | 	// Clone the repository into the TMP_DIR
246 | 	$commands[] = sprintf(
247 | 		'git clone --depth=1 --branch %s %s %s'
248 | 		, BRANCH
249 | 		, REMOTE_REPOSITORY
250 | 		, TMP_DIR
251 | 	);
252 | } else {
253 | 	// TMP_DIR exists and hopefully already contains the correct remote origin
254 | 	// so we'll fetch the changes and reset the contents.
255 | 	$commands[] = sprintf(
256 | 		'git --git-dir="%s.git" --work-tree="%s" fetch --tags origin %s'
257 | 		, TMP_DIR
258 | 		, TMP_DIR
259 | 		, BRANCH
260 | 	);
261 | 	$commands[] = sprintf(
262 | 		'git --git-dir="%s.git" --work-tree="%s" reset --hard FETCH_HEAD'
263 | 		, TMP_DIR
264 | 		, TMP_DIR
265 | 	);
266 | }
267 | 
268 | // Update the submodules
269 | $commands[] = sprintf(
270 | 	'git submodule update --init --recursive'
271 | );
272 | 
273 | // Describe the deployed version
274 | if (defined('VERSION_FILE') && VERSION_FILE !== '') {
275 | 	$commands[] = sprintf(
276 | 		'git --git-dir="%s.git" --work-tree="%s" describe --always > %s'
277 | 		, TMP_DIR
278 | 		, TMP_DIR
279 | 		, VERSION_FILE
280 | 	);
281 | }
282 | 
283 | // Backup the TARGET_DIR
284 | // without the BACKUP_DIR for the case when it's inside the TARGET_DIR
285 | if (defined('BACKUP_DIR') && BACKUP_DIR !== false) {
286 | 	$commands[] = sprintf(
287 | 		"tar --exclude='%s*' -czf %s/%s-%s-%s.tar.gz %s*"
288 | 		, BACKUP_DIR
289 | 		, BACKUP_DIR
290 | 		, basename(TARGET_DIR)
291 | 		, md5(TARGET_DIR)
292 | 		, date('YmdHis')
293 | 		, TARGET_DIR // We're backing up this directory into BACKUP_DIR
294 | 	);
295 | }
296 | 
297 | // Invoke composer
298 | if (defined('USE_COMPOSER') && USE_COMPOSER === true) {
299 | 	$commands[] = sprintf(
300 | 		'composer --no-ansi --no-interaction --no-progress --working-dir=%s install %s'
301 | 		, TMP_DIR
302 | 		, (defined('COMPOSER_OPTIONS')) ? COMPOSER_OPTIONS : ''
303 | 	);
304 | 	if (defined('COMPOSER_HOME') && is_dir(COMPOSER_HOME)) {
305 | 		putenv('COMPOSER_HOME='.COMPOSER_HOME);
306 | 	}
307 | }
308 | 
309 | // ==================================================[ Deployment ]===
310 | 
311 | // Compile exclude parameters
312 | $exclude = '';
313 | foreach (unserialize(EXCLUDE) as $exc) {
314 | 	$exclude .= ' --exclude='.$exc;
315 | }
316 | // Deployment command
317 | $commands[] = sprintf(
318 | 	'rsync -rltgoDzvO %s %s %s %s'
319 | 	, TMP_DIR
320 | 	, TARGET_DIR
321 | 	, (DELETE_FILES) ? '--delete-after' : ''
322 | 	, $exclude
323 | );
324 | 
325 | // =======================================[ Post-Deployment steps ]===
326 | 
327 | // Remove the TMP_DIR (depends on CLEAN_UP)
328 | if (CLEAN_UP) {
329 | 	$commands['cleanup'] = sprintf(
330 | 		'rm -rf %s'
331 | 		, TMP_DIR
332 | 	);
333 | }
334 | 
335 | // =======================================[ Run the command steps ]===
336 | $output = '';
337 | foreach ($commands as $command) {
338 | 	set_time_limit(TIME_LIMIT); // Reset the time limit for each command
339 | 	if (file_exists(TMP_DIR) && is_dir(TMP_DIR)) {
340 | 		chdir(TMP_DIR); // Ensure that we're in the right directory
341 | 	}
342 | 	$tmp = array();
343 | 	exec($command.' 2>&1', $tmp, $return_code); // Execute the command
344 | 	// Output the result
345 | 	printf('
346 | <span class="prompt">$</span> <span class="command">%s</span>
347 | <div class="output">%s</div>
348 | '
349 | 		, htmlentities(trim($command))
350 | 		, htmlentities(trim(implode("\n", $tmp)))
351 | 	);
352 | 	$output .= ob_get_contents();
353 | 	ob_flush(); // Try to output everything as it happens
354 | 
355 | 	// Error handling and cleanup
356 | 	if ($return_code !== 0) {
357 | 		header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error', true, 500);
358 | 		printf('
359 | <div class="error">
360 | Error encountered!
361 | Stopping the script to prevent possible data loss.
362 | CHECK THE DATA IN YOUR TARGET DIR!
363 | </div>
364 | '
365 | 		);
366 | 		if (CLEAN_UP) {
367 | 			$tmp = shell_exec($commands['cleanup']);
368 | 			printf('
369 | 
370 | 
371 | Cleaning up temporary files ...
372 | 
373 | <span class="prompt">$</span> <span class="command">%s</span>
374 | <div class="output">%s</div>
375 | '
376 | 				, htmlentities(trim($commands['cleanup']))
377 | 				, htmlentities(trim($tmp))
378 | 			);
379 | 		}
380 | 		$error = sprintf(
381 | 			'Deployment error on %s using %s!'
382 | 			, $_SERVER['HTTP_HOST']
383 | 			, __FILE__
384 | 		);
385 | 		error_log($error);
386 | 		if (EMAIL_ON_ERROR) {
387 | 			$output .= ob_get_contents();
388 | 			$headers = array();
389 | 			$headers[] = sprintf('From: Simple PHP Git deploy script <simple-php-git-deploy@%s>', $_SERVER['HTTP_HOST']);
390 | 			$headers[] = sprintf('X-Mailer: PHP/%s', phpversion());
391 | 			mail(EMAIL_ON_ERROR, $error, strip_tags(trim($output)), implode("\r\n", $headers));
392 | 		}
393 | 		break;
394 | 	}
395 | }
396 | ?>
397 | 
398 | Done.
399 | </pre>
400 | </body>
401 | </html>
402 | 


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