Project

General

Profile

1
<?php
2
/**
3
 * $Id: addon.precheck.inc.php 1289 2010-02-10 15:13:21Z kweitzel $
4
 * Website Baker Add-On precheck functions
5
 *
6
 * This file contains the functions of the pretest performed upfront
7
 * of the Add-On installation process. The functions allows developers
8
 * to specify requirements for their Add-On.
9
 *
10
 * LICENSE: GNU Lesser General Public License 3.0
11
 * 
12
 * @author		Christian Sommer
13
 * @copyright	(c) 2009
14
 * @license		http://www.gnu.org/copyleft/lesser.html
15
 * @version		0.2.3
16
 * @platform	Website Baker 2.7
17
 *
18
 * Website Baker Project <http://www.websitebaker.org/>
19
 * Copyright (C) 2004-2009, Ryan Djurovich
20
 *
21
 * Website Baker is free software; you can redistribute it and/or modify
22
 * it under the terms of the GNU General Public License as published by
23
 * the Free Software Foundation; either version 2 of the License, or
24
 * (at your option) any later version.
25
 *
26
 * Website Baker is distributed in the hope that it will be useful,
27
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29
 * GNU General Public License for more details.
30
 *
31
 * You should have received a copy of the GNU General Public License
32
 * along with Website Baker; if not, write to the Free Software
33
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
34
*/
35

    
36
// prevent this file from being accessed directly
37
if (!defined('WB_PATH')) die(header('Location: ../index.php'));
38

    
39
function getVersion($version, $strip_suffix = true)
40
{
41
	/**
42
	 * This funtion creates a version string following the major.minor.revision convention
43
	 * The minor and revision part of the version may not exceed 999 (three digits)
44
	 * An optional suffix part can be added after revision (requires $strip_suffix = false)
45
	 *
46
	 * EXAMPLES: input --> output
47
	 *	5 --> 5.000000; 5.0 --> 5.000000; 5.0.0 --> 5.000000
48
	 * 	5.2 --> 5.002000; 5.20 --> 5.002000; 5.2.0 --> 5.002000
49
	 * 	5.21 --> 5.002001; 5.2.1 --> 5.002001;
50
	 * 	5.27.1 --> 5.027001; 5.2.71 --> 5.002071;
51
	 * 	5.27.1 rc1 --> 5.027001_RC1 ($strip_suffix:= false)
52
	 */
53
	// replace comma by decimal point
54
	$version = str_replace(',', '.', $version);
55

    
56
	// convert version into major.minor.revision numbering system
57
	list($major, $minor, $revision) = explode('.', $version, 3);
58

    
59
	// convert versioning style 5.21 into 5.2.1
60
	if ($revision == '' && strlen(intval($minor)) == 2) {
61
		$revision = substr($minor, -1);
62
		$minor = substr($minor, 0, 1);
63
	}
64
	
65
	// extract possible non numerical suffix from revision part (e.g. Alpha, Beta, RC1)
66
	$suffix = strtoupper(trim(substr($revision, strlen(intval($revision)))));
67

    
68
	// return standard version number (minor and revision numbers may not exceed 999)
69
	return (int) $major . '.' . sprintf('%03d', (int) $minor) . sprintf('%03d', (int) $revision) . 
70
		(($strip_suffix == false && $suffix != '') ? '_' . $suffix : '');
71
}
72

    
73
/**
74
 *	As "version_compare" it self seems only got trouble 
75
 *	within words like "Alpha", "Beta" a.s.o. this function
76
 *	only modify the version-string in the way that these words are replaced by values/numbers.
77
 *
78
 *	E.g:	"1.2.3 Beta2" => "1.2.322"
79
 *			"0.1.1 ALPHA" => "0.1.11"
80
 *
81
 *	Notice:	Please keep in mind, that this will not correct the way "version_control" 
82
 *			handel "1 < 1.0 < 1.0.0 < 1.0.0.0" and will not correct missformed version-strings
83
 *			below 2.7, e.g. "1.002 released candidate 2.3"
84
 *			
85
 *	@since	2.8.0 RC2
86
 *
87
 *	@param	string	A versionstring
88
 *	@return	string	The modificated versionstring
89
 *
90
 */
91
function getVersion2 ($version="") {
92
	
93
	$states = array (
94
		'1' => "alpha",
95
		'2' => "beta",
96
		'4' => "rc",
97
		'8' => "final"	
98
	);
99

    
100
	$version = strtolower($version);
101
	
102
	foreach($states as $value=>$keys) $version = str_replace($keys, $value, $version);
103

    
104
	$version = str_replace(" ", "", $version);
105

    
106
	return $version;
107
}
108

    
109
function versionCompare($version1, $version2, $operator = '>=')
110
{
111
	/**
112
	 * This funtion performs a comparison of two provided version strings
113
	 * The versions are first converted into a string following the major.minor.revision 
114
	 * convention and performs a version_compare afterwards.
115
	 */
116
	// return version_compare(getVersion($version1), getVersion($version2), $operator);
117
	return version_compare(getVersion2($version1), getVersion2($version2), $operator);
118
}
119

    
120
function sortPreCheckArray($precheck_array)
121
{
122
	/**
123
	 * This funtion sorts the precheck array to a common format
124
	 */
125
	// define desired precheck order
126
	$key_order = array('WB_VERSION', 'WB_ADDONS', 'PHP_VERSION', 'PHP_EXTENSIONS', 'PHP_SETTINGS', 'CUSTOM_CHECKS');
127

    
128
	$temp_array = array();
129
	foreach($key_order as $key) {
130
		if (!isset($precheck_array[$key])) continue;
131
		$temp_array[$key] = $precheck_array[$key];
132
	}
133
	return $temp_array;
134
}
135

    
136
function preCheckAddon($temp_addon_file)
137
{
138
	/**
139
	 * This funtion performs pretest upfront of the Add-On installation process.
140
	 * The requirements can be specified via the array $PRECHECK which needs to
141
	 * be defined in the optional Add-on file precheck.php.
142
	 */
143
	global $database, $admin, $TEXT, $HEADING, $MESSAGE;
144
	
145
	// path to the temporary Add-on folder
146
	$temp_path = WB_PATH . '/temp/unzip';
147
	
148
	// check if file precheck.php exists for the Add-On uploaded via WB installation routine
149
	if (!file_exists($temp_path . '/precheck.php')) return;
150
	
151
	// unset any previous declared PRECHECK array
152
	unset($PRECHECK);
153

    
154
	// include Add-On precheck.php file
155
	include($temp_path . '/precheck.php');
156
	
157
	// check if there are any Add-On requirements to check for
158
	if (!(isset($PRECHECK) && count($PRECHECK) > 0)) return;
159
	
160
	// sort precheck array
161
	$PRECHECK = sortPreCheckArray($PRECHECK);
162
	
163
	$failed_checks = 0;
164
	$msg = array();
165
	// check if specified addon requirements are fullfilled
166
	foreach ($PRECHECK as $key => $value) {
167
		switch ($key) {
168
			case 'WB_VERSION':
169
				if (isset($value['VERSION'])) {
170
					// obtain operator for string comparison if exist
171
					$operator = (isset($value['OPERATOR']) &&  trim($value['OPERATOR']) != '') ? $value['OPERATOR'] : '>=';
172
				
173
					// compare versions and extract actual status
174
					$status = versionCompare(WB_VERSION, $value['VERSION'], $operator);
175
					$msg[] = array(
176
						'check'		=> 'WB-' . $TEXT['VERSION'] .': ',
177
						'required'	=> htmlentities($operator) . $value['VERSION'],
178
						'actual'	=> WB_VERSION,
179
						'status'	=> $status
180
					);
181

    
182
					// increase counter if required
183
					if (!$status) $failed_checks++;
184
				}
185
				break;
186

    
187
			case 'WB_ADDONS':
188
				if (is_array($PRECHECK['WB_ADDONS'])) {
189
					foreach($PRECHECK['WB_ADDONS'] as $addon => $values) {
190
						if (is_array($values)) {
191
							// extract module version and operator
192
							$version = (isset($values['VERSION']) &&  trim($values['VERSION']) != '') ? $values['VERSION'] : '';
193
							$operator = (isset($values['OPERATOR']) &&  trim($values['OPERATOR']) != '') ? $values['OPERATOR'] : '>=';
194
						} else {
195
							// no version and operator specified (only check if addon exists)
196
							$addon = strip_tags($values);
197
							$version = ''; $operator = '';
198
						}
199
					
200
						// check if addon is listed in WB database
201
						$table = TABLE_PREFIX . 'addons';
202
						$sql = "SELECT * FROM `$table` WHERE `directory` = '" . addslashes($addon) . "'";
203
						$results = $database->query($sql);
204
					
205
						$status = false; $addon_status = $TEXT['NOT_INSTALLED'];
206
						if ($results && $row = $results->fetchRow()) {
207
							$status = true; 
208
							$addon_status = $TEXT['INSTALLED'];
209
						
210
							// compare version if required
211
							if ($version != '') {
212
								$status = versionCompare($row['version'], $version, $operator);
213
								$addon_status = $row['version'];
214
							}
215
						}
216
					
217
						// provide addon status
218
						$msg[] = array(
219
							'check'		=> '&nbsp; ' . $TEXT['ADDON'] . ': ' . htmlentities($addon),
220
							'required'	=> ($version != '') ? $operator . '&nbsp;' . $version : $TEXT['INSTALLED'],
221
							'actual'	=> $addon_status,
222
							'status'	=> $status
223
						);
224
						
225
						// increase counter if required
226
						if (!$status) $failed_checks++;
227
					}
228
				}
229
				break;
230

    
231
			case 'PHP_VERSION':
232
				if (isset($value['VERSION'])) {
233
					// obtain operator for string comparison if exist
234
					$operator = (isset($value['OPERATOR']) &&  trim($value['OPERATOR']) != '') ? $value['OPERATOR'] : '>=';
235
				
236
					// compare versions and extract actual status
237
					$status = versionCompare(PHP_VERSION, $value['VERSION'], $operator);
238
					$msg[] = array(
239
						'check'		=> 'PHP-' . $TEXT['VERSION'] .': ',
240
						'required'	=> htmlentities($operator) . '&nbsp;' . $value['VERSION'],
241
						'actual'	=> PHP_VERSION,
242
						'status'	=> $status
243
					);
244

    
245
					// increase counter if required
246
					if (!$status) $failed_checks++;
247

    
248
				}
249
				break;
250

    
251
			case 'PHP_EXTENSIONS':
252
				if (is_array($PRECHECK['PHP_EXTENSIONS'])) {
253
					foreach($PRECHECK['PHP_EXTENSIONS'] as $extension) {
254
						$status = extension_loaded(strtolower($extension));
255
						$msg[] = array(
256
							'check'		=> '&nbsp; ' . $TEXT['EXTENSION'] . ': ' . htmlentities($extension),
257
							'required'	=> $TEXT['INSTALLED'],
258
							'actual'	=> ($status) ? $TEXT['INSTALLED'] : $TEXT['NOT_INSTALLED'],
259
							'status'	=> $status
260
						);
261

    
262
						// increase counter if required
263
						if (!$status) $failed_checks++;
264
					}
265
				}
266
				break;
267

    
268
			case 'PHP_SETTINGS':
269
				if (is_array($PRECHECK['PHP_SETTINGS'])) {
270
					foreach($PRECHECK['PHP_SETTINGS'] as $setting => $value) {
271
						$actual_setting = ($temp = ini_get($setting)) ? $temp : 0;
272
						$status = ($actual_setting == $value);
273
					
274
						$msg[] = array(
275
							'check'		=> '&nbsp; '. ($setting),
276
							'required'	=> $value,
277
							'actual'	=> $actual_setting,
278
							'status'	=> $status
279
						);
280

    
281
						// increase counter if required
282
						if (!$status) $failed_checks++;
283
					}
284
				}
285
				break;
286

    
287
			case 'CUSTOM_CHECKS':
288
				if (is_array($PRECHECK['CUSTOM_CHECKS'])) {
289
					foreach($PRECHECK['CUSTOM_CHECKS'] as $key => $values) {
290
						$status = (true === array_key_exists('STATUS', $values )) ? $values['STATUS'] : false;
291
						$msg[] = array(
292
							'check'		=> $key,
293
							'required'	=> $values['REQUIRED'],
294
							'actual'	=> $values['ACTUAL'],
295
							'status'	=> $status
296
						);
297
					}
298

    
299
					// increase counter if required
300
					if (!$status) $failed_checks++;
301
				}
302
				break;
303
		}
304
	}
305

    
306
	// leave if all requirements are fullfilled
307
	if ($failed_checks == 0) return;
308
	
309
	// output summary table with requirements not fullfilled
310
	echo <<< EOT
311
	<h2>{$HEADING['ADDON_PRECHECK_FAILED']}</h2>
312
	<p>{$MESSAGE['ADDON']['PRECHECK_FAILED']}</p> 
313

    
314
	<table width="700px" cellpadding="4" border="0" style="margin: 0.5em; border-collapse: collapse; border: 1px solid silver;">
315
	<tr>
316
		<th>{$TEXT['REQUIREMENT']}:</th>
317
		<th>{$TEXT['REQUIRED']}:</th>
318
		<th>{$TEXT['CURRENT']}:</th>
319
	</tr>
320
EOT;
321

    
322
	foreach($msg as $check) {
323
		echo '<tr>';
324
		$style = $check['status'] ? 'color: #46882B;' : 'color: #C00;';
325
		foreach($check as $key => $value) {
326
			if ($key == 'status') continue;
327
			
328
			echo '<td style="' . $style . '">' . $value . '</td>';
329
		}
330
		echo '</tr>';
331
	}
332
	echo '</table>';
333

    
334
	// delete the temp unzip directory
335
	rm_full_dir($temp_path);	
336

    
337
	// delete the temporary zip file of the Add-on
338
	if(file_exists($temp_addon_file)) { unlink($temp_addon_file); }	
339
	
340
	// output status message and die
341
	$admin->print_error('');
342
}
343

    
344
?>
(1-1/15)