Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
<?php
/*
Copyright (c) 2012, ISPConfig UG
Contributors: web wack creations, http://www.web-wack.at
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* 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.
* Neither the name of ISPConfig nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
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.
*/
require_once('aps_base.inc.php');
@set_time_limit(0);
@ignore_user_abort(1);
class ApsCrawler extends ApsBase
{
//public $app_download_url_list = array();
/**
* Constructor
*
* @param $app the application instance (db handle + log method)
* @param $interface_mode act in interface (true) or server mode (false)
*/
public function __construct($app, $interface_mode = false)
{
parent::__construct($app, 'APS crawler: ', $interface_mode);
}
/**
* Before the cron is executed, make sure all necessary options are set
* and all functions (i.e. cURL) are available
*/
private function checkRequirements()
{
global $app;
try
{
// Check if allow_url_fopen is enabled
if(!@ini_get('allow_url_fopen')) throw new Exception('allow_url_fopen is not enabled');
// Check if the cURL module is available
if(!function_exists('curl_version')) throw new Exception('cURL is not available');
// Check if used folders are writable
if($this->interface_mode)
{
if(!is_writable($this->interface_pkg_dir))
throw new Exception('the folder '.basename($this->interface_pkg_dir).' is not writable');
}
else
{
if(!is_writable($this->packages_dir))
throw new Exception('the folder '.basename($this->packages_dir).' is not writable');
}
return true;
}
catch(Exception $e)
{
$app->log($this->log_prefix.'Aborting execution because '.$e->getMessage(), LOGLEVEL_ERROR);
return false;
}
}
/**
* Remove a directory recursively
* In case of error be silent
*
* @param $dir the directory to remove
*/
private function removeDirectory($dir)
{
if(is_dir($dir))
{
$files = scandir($dir);
foreach($files as $file)
{
if($file != '.' && $file != '..')
if(filetype($dir.'/'.$file) == 'dir') $this->removeDirectory($dir.'/'.$file);
else @unlink($dir.'/'.$file);
}
reset($files);
@rmdir($dir);
}
}
/**
* Fetch HTML data from one or more given URLs
* If a string is given, a string is returned, if an array of URLs should
* be fetched, the responses of the parallel queries are returned as array
*
* @param $input the string or array to fetch
* @return $ret a query response string or array
*/
private function fetchPage($input)
{
$ret = array();
$url = array();
$conn = array();
// Make sure we are working with an array, further on
if(!is_array($input)) $url[] = $input;
else $url = $input;
// Build the single cURL handles and add them to a multi handle
$mh = curl_multi_init();
for($i = 0; $i < count($url); $i++)
{
$conn[$i] = curl_init('http://'.$this->fetch_url.$url[$i]);
curl_setopt($conn[$i], CURLOPT_RETURNTRANSFER, true);
curl_multi_add_handle($mh, $conn[$i]);
}
$active = 0;
do curl_multi_exec($mh, $active);
while($active > 0);
// Get the response(s)
for($i = 0; $i < count($url); $i++)
{
$ret[$i] = curl_multi_getcontent($conn[$i]);
curl_multi_remove_handle($mh, $conn[$i]);
curl_close($conn[$i]);
}
curl_multi_close($mh);
if(count($url) == 1) $ret = $ret[0];
return $ret;
}
/**
* Fetch binary data from a given array
* The data is retrieved in binary mode and
* then directly written to an output file
*
* @param $input a specially structed array
* @see $this->startUpdate()
*/
private function fetchFiles($input)
{
$fh = array();
$url = array();
$conn = array();
// Build the single cURL handles and add them to a multi handle
$mh = curl_multi_init();
// Process each app
for($i = 0; $i < count($input); $i++)
{
$conn[$i] = curl_init($input[$i]['url']);
$fh[$i] = fopen($input[$i]['localtarget'], 'wb');
curl_setopt($conn[$i], CURLOPT_BINARYTRANSFER, true);
curl_setopt($conn[$i], CURLOPT_FILE, $fh[$i]);
curl_setopt($conn[$i], CURLOPT_TIMEOUT, 0);
curl_setopt($conn[$i], CURLOPT_FAILONERROR, 1);
curl_setopt($conn[$i], CURLOPT_FOLLOWLOCATION, 1);
curl_multi_add_handle($mh, $conn[$i]);
}
$active = 0;
do curl_multi_exec($mh, $active);
while($active > 0);
// Close the handles
for($i = 0; $i < count($input); $i++)
{
fclose($fh[$i]);
curl_multi_remove_handle($mh, $conn[$i]);
curl_close($conn[$i]);
}
curl_multi_close($mh);
}
/**
* A method to build query URLs out of a list of vendors
*
*/
private function formatVendorCallback($array_item)
{
$array_item = str_replace(' ', '%20', $array_item);
$array_item = str_replace('http://', '', $array_item);
$array_item = '/'.$this->aps_version.'.atom?vendor='.$array_item.'&pageSize=100';
return($array_item);
}
/**
* The main method which performs the actual crawling
*/
public function startCrawler()
{
global $app;
try
{
// Make sure the requirements are given so that this script can execute
$req_ret = $this->checkRequirements();
if(!$req_ret) return false;
// Execute the open task and first fetch all vendors (APS catalog API 1.1, p. 12)
$app->log($this->log_prefix.'Fetching data from '.$this->fetch_url);
$vendor_page = $this->fetchPage('/all-app/'); //$vendor_page = $this->fetchPage('/'.$this->aps_version.'/');
preg_match_all("/\<a href=\"(.+)\/\" class=\"vendor\"/i", $vendor_page, $matches);
$vendors = array_map('urldecode', $matches[1]);
if(!$vendors) throw new Exception('Unable to fetch vendors. Aborting');
// Format all vendors for further processing (i.e. typo3.org -> /1.atom?vendor=typo3.org&pageSize=100
//array_walk($vendors, array($this, 'formatVendorCallback'));
if(is_array($vendors)) {
foreach($vendors as $key => $array_item) {
$vendors[$key] = $this->formatVendorCallback($array_item);
}
}
// Process all vendors in chunks of 50 entries
$vendor_chunks = array_chunk($vendors, 50);
//var_dump($vendor_chunks);
// Get all known apps from the database and the highest known version
// Note: A dirty hack is used for numerical sorting of the VARCHAR field Version: +0 -> cast
// A longer but typesafe way would be: ORDER BY CAST(REPLACE(Version, '.', '') AS UNSIGNED) DESC
$existing_apps = $app->db->queryAllRecords("SELECT * FROM (
SELECT name AS Name, CONCAT(version, '-', CAST(`release` AS CHAR)) AS CurrentVersion
FROM aps_packages ORDER BY REPLACE(version, '.', '')+0 DESC, `release` DESC
) as Versions GROUP BY name");
//var_dump($existing_apps);
// Used for statistics later
$apps_in_repo = 0;
$apps_updated = 0;
$apps_downloaded = 0;
$apps_to_dl = array();
for($i = 0; $i < count($vendor_chunks); $i++)
{
// Fetch all apps for the current chunk of vendors
$apps = $this->fetchPage($vendor_chunks[$i]);
for($j = 0; $j < count($apps); $j++)
{
// Before parsing, make sure it's worth the work by checking if at least one app exists
$apps_count = substr_count($apps[$j], '<opensearch:totalResults>0</opensearch:totalResults>');
if($apps_count == 0) // obviously this vendor provides one or more apps
{
// Rename namespaces and register them
$xml = str_replace("xmlns=", "ns=", $apps[$j]);
$sxe = new SimpleXMLElement($xml);
$namespaces = $sxe->getDocNamespaces(true);
foreach($namespaces as $ns => $url) $sxe->registerXPathNamespace($ns, $url);
// Fetching values of interest
$app_name = parent::getXPathValue($sxe, 'entry[position()=1]/a:name');
$app_version = parent::getXPathValue($sxe, 'entry[position()=1]/a:version');
$app_release = parent::getXPathValue($sxe, 'entry[position()=1]/a:release');
// Find out a (possibly) existing package version
$ex_ver = '';
/*
array_walk($existing_apps,
create_function('$v, $k, $ex_ver', 'if($v["Name"] == "'.$app_name.'") $ex_ver = $v["CurrentVersion"];'), &$ex_ver);
*/
if(is_array($existing_apps)) {
foreach($existing_apps as $k => $v) {
if($v["Name"] == $app_name) $ex_ver = $v["CurrentVersion"];
}
}
$new_ver = $app_version.'-'.$app_release;
$local_intf_folder = $this->interface_pkg_dir.'/'.$app_name.'-'.$new_ver.'.app.zip/';
// Proceed if a newer or at least equal version has been found with server mode or
// interface mode is activated and there are no valid APP-META.xml and PKG_URL existing yet
if((!$this->interface_mode && version_compare($new_ver, $ex_ver) >= 0) || ($this->interface_mode && (!file_exists($local_intf_folder.'APP-META.xml') || filesize($local_intf_folder.'APP-META.xml') == 0 || !file_exists($local_intf_folder.'PKG_URL') || filesize($local_intf_folder.'PKG_URL') == 0))){
// Check if we already have an old version of this app
if(!empty($ex_ver) && version_compare($new_ver, $ex_ver) == 1) $apps_updated++;
$app_dl = parent::getXPathValue($sxe, "entry[position()=1]/link[@a:type='aps']/@href");
$app_filesize = parent::getXPathValue($sxe, "entry[position()=1]/link[@a:type='aps']/@length");
$app_metafile = parent::getXPathValue($sxe, "entry[position()=1]/link[@a:type='meta']/@href");
//$this->app_download_url_list[$app_name.'-'.$new_ver.'.app.zip'] = $app_dl;
// Skip ASP.net packages because they can't be used at all
$asp_handler = parent::getXPathValue($sxe, '//aspnet:handler');
$asp_permissions = parent::getXPathValue($sxe, '//aspnet:permissions');
$asp_version = parent::getXPathValue($sxe, '//aspnet:version');
if(!empty($asp_handler) || !empty($asp_permissions) || !empty($asp_version)) continue;
// Interface mode (download only parts)
if($this->interface_mode)
{
// Delete an obviously out-dated version from the system and DB
if(!empty($ex_ver) && version_compare($new_ver, $ex_ver) == 1)
{
$old_folder = $this->interface_pkg_dir.'/'.$app_name.'-'.$ex_ver.'.app.zip';
if(file_exists($old_folder)) $this->removeDirectory($old_folder);
/*
$app->db->query("UPDATE aps_packages SET package_status = '".PACKAGE_OUTDATED."' WHERE name = '".
$app->db->quote($app_name)."' AND CONCAT(version, '-', CAST(`release` AS CHAR)) = '".
$app->db->quote($ex_ver)."';");
*/
$tmp = $app->db->queryOneRecord("SELECT id FROM aps_packages WHERE name = '".
$app->db->quote($app_name)."' AND CONCAT(version, '-', CAST(`release` AS CHAR)) = '".
$app->db->quote($ex_ver)."';");
$app->db->datalogUpdate('aps_packages', "package_status = ".PACKAGE_OUTDATED, 'id', $tmp['id']);
unset($tmp);
}
// Create the local folder if not yet existing
if(!file_exists($local_intf_folder)) @mkdir($local_intf_folder, 0777, true);
// Save the package URL in an extra file because it's not part of the APP-META.xml file
@file_put_contents($local_intf_folder.'PKG_URL', $app_dl);
// Download the meta file
$local_metafile = $local_intf_folder.'APP-META.xml';
if(!file_exists($local_metafile) || filesize($local_metafile) == 0)
{
$apps_to_dl[] = array('name' => 'APP-META.xml',
'url' => $app_metafile,
'filesize' => 0,
'localtarget' => $local_metafile);
$apps_downloaded++;
}
// Download package license
$license = parent::getXPathValue($sxe, "entry[position()=1]/link[@a:type='eula']/@href");
if($license != '')
{
$local_license = $local_intf_folder.'LICENSE';
if(!file_exists($local_license) || filesize($local_license) == 0)
{
$apps_to_dl[] = array('name' => basename($license),
'url' => $license,
'filesize' => 0,
'localtarget' => $local_license);
}
}
// Download package icon
$icon = parent::getXPathValue($sxe, "entry[position()=1]/link[@a:type='icon']/@href");
if($icon != '')
{
$local_icon = $local_intf_folder.basename($icon);
if(!file_exists($local_icon) || filesize($local_icon) == 0)
{
$apps_to_dl[] = array('name' => basename($icon),
'url' => $icon,
'filesize' => 0,
'localtarget' => $local_icon);
}
}
// Download available screenshots
$screenshots = parent::getXPathValue($sxe, "entry[position()=1]/link[@a:type='screenshot']", true);
if(!empty($screenshots))
{
foreach($screenshots as $screen)
{
$local_screen = $local_intf_folder.basename($screen['href']);
if(!file_exists($local_screen) || filesize($local_screen) == 0)
{
$apps_to_dl[] = array('name' => basename($screen['href']),
'url' => $screen['href'],
'filesize' => 0,
'localtarget' => $local_screen);
}
}
}
}
else // Server mode (download whole ZIP archive)
{
// Delete an obviously out-dated version from the system
if(!empty($ex_ver) && version_compare($new_ver, $ex_ver) == 1)
{
$old_file = $this->packages_dir.'/'.$app_name.'-'.$ex_ver.'.app.zip';
if(file_exists($old_file)) $this->removeDirectory($old_file);
}
// Attention: $new_ver can also be == $ex_ver (according to version_compare >= 0)
$local_zip = $this->packages_dir.'/'.$app_name.'-'.$new_ver.'.app.zip';
// Before re-downloading a file, make sure it's not yet existing on HDD (due to DB inconsistency)
if((file_exists($local_zip) && (filesize($local_zip) == $app_filesize)) === false)
{
$apps_to_dl[] = array('name' => $app_name,
'url' => $app_dl,
'filesize' => $app_filesize,
'localtarget' => $local_zip);
$apps_downloaded++;
}
}
}
unset($sxe);
$apps_in_repo++;
}
}
//var_dump($apps);
// For memory reasons, unset the current vendor and his apps
unset($apps);
}
// Shuffle the download array (in order to compensate unexpected php aborts)
shuffle($apps_to_dl);
// After collecting all provisioned apps, download them
$apps_to_dl_chunks = array_chunk($apps_to_dl, 10);
for($i = 0; $i < count($apps_to_dl_chunks); $i++)
{
$this->fetchFiles($apps_to_dl_chunks[$i]);
// Check the integrity of all downloaded files
// but exclude cases where no filesize is available (i.e. screenshot or metafile download)
for($j = 0; $j < count($apps_to_dl_chunks[$i]); $j++)
{
if($apps_to_dl_chunks[$i][$j]['filesize'] != 0 &&
$apps_to_dl_chunks[$i][$j]['filesize'] != filesize($apps_to_dl_chunks[$i][$j]['localtarget']))
{
$app->log($this->log_prefix.' The filesize of the package "'.
$apps_to_dl_chunks[$i][$j]['name'].'" is wrong. Download failure?', LOGLEVEL_WARN);
}
}
}
$app->log($this->log_prefix.'Processed '.$apps_in_repo.
' apps from the repo. Downloaded '.$apps_updated.
' updates, '.$apps_downloaded.' new apps');
}
catch(Exception $e)
{
$app->log($this->log_prefix.$e->getMessage(), LOGLEVEL_ERROR);
return false;
}
}
/**
* Read in all possible packages from the interface packages folder and
* check if they are not ASP.net code (as this can't be processed).
*
* Note: There's no need to check if the packages to register are newer
* than those in the database because this already happended in startCrawler()
*/
public function parseFolderToDB()
{
global $app;
try
{
// This method must be used in interface mode
if(!$this->interface_mode) return false;
$pkg_list = array();
// Read in every package having a correct filename
$temp_handle = @dir($this->interface_pkg_dir);
if(!$temp_handle) throw new Exception('The temp directory is not accessible');
while($folder = $temp_handle->read())
if(substr($folder, -8) == '.app.zip') $pkg_list[] = $folder;
$temp_handle->close();
// If no packages are available -> exception (because at this point there should exist packages)
if(empty($pkg_list)) throw new Exception('No packages to read in');
// Get registered packages and mark non-existant packages with an error code to omit the install
$existing_packages = array();
$path_query = $app->db->queryAllRecords('SELECT path AS Path FROM aps_packages;');
foreach($path_query as $path) $existing_packages[] = $path['Path'];
$diff = array_diff($existing_packages, $pkg_list);
foreach($diff as $todelete) {
/*$app->db->query("UPDATE aps_packages SET package_status = '".PACKAGE_ERROR_NOMETA."'
WHERE path = '".$app->db->quote($todelete)."';");*/
$tmp = $app->db->queryOneRecord("SELECT id FROM aps_packages WHERE path = '".$app->db->quote($todelete)."';");
$app->db->datalogUpdate('aps_packages', "package_status = ".PACKAGE_ERROR_NOMETA, 'id', $tmp['id']);
unset($tmp);
}
// Register all new packages
$new_packages = array_diff($pkg_list, $existing_packages);
foreach($new_packages as $pkg)
{
// Load in meta file if existing and register its namespaces
$metafile = $this->interface_pkg_dir.'/'.$pkg.'/APP-META.xml';
if(!file_exists($metafile))
{
$app->log($this->log_prefix.'Cannot read metadata from '.$pkg, LOGLEVEL_ERROR);
continue;
}
$metadata = file_get_contents($metafile);
$metadata = str_replace("xmlns=", "ns=", $metadata);
$sxe = new SimpleXMLElement($metadata);
$namespaces = $sxe->getDocNamespaces(true);
foreach($namespaces as $ns => $url) $sxe->registerXPathNamespace($ns, $url);
// Insert the new package
$pkg_name = parent::getXPathValue($sxe, 'name');
$pkg_category = parent::getXPathValue($sxe, '//category');
$pkg_version = parent::getXPathValue($sxe, 'version');
$pkg_release = parent::getXPathValue($sxe, 'release');
//$pkg_url = $this->app_download_url_list[$pkg];
$pkg_url = @file_get_contents($this->interface_pkg_dir.'/'.$pkg.'/PKG_URL');
/*
$app->db->query("INSERT INTO `aps_packages`
(`path`, `name`, `category`, `version`, `release`, `package_status`) VALUES
('".$app->db->quote($pkg)."', '".$app->db->quote($pkg_name)."',
'".$app->db->quote($pkg_category)."', '".$app->db->quote($pkg_version)."',
".$app->db->quote($pkg_release).", ".PACKAGE_ENABLED.");");
*/
// Insert only if data is complete
if($pkg != '' && $pkg_name != '' && $pkg_category != '' && $pkg_version != '' && $pkg_release != '' && $pkg_url){
$insert_data = "(`path`, `name`, `category`, `version`, `release`, `package_url`, `package_status`) VALUES
('".$app->db->quote($pkg)."', '".$app->db->quote($pkg_name)."',
'".$app->db->quote($pkg_category)."', '".$app->db->quote($pkg_version)."',
".$app->db->quote($pkg_release).", '".$app->db->quote($pkg_url)."', ".PACKAGE_ENABLED.");";
$app->db->datalogInsert('aps_packages', $insert_data, 'id');
} else {
if(file_exists($this->interface_pkg_dir.'/'.$pkg)) $this->removeDirectory($this->interface_pkg_dir.'/'.$pkg);
}
}
}
catch(Exception $e)
{
$app->log($this->log_prefix.$e->getMessage(), LOGLEVEL_ERROR);
$app->error($e->getMessage());
return false;
}
}
/**
* Add missing package URLs to database
*/
public function fixURLs()
{
global $app;
try
{
// This method must be used in interface mode
if(!$this->interface_mode) return false;
$incomplete_pkgs = $app->db->queryAllRecords("SELECT * FROM aps_packages WHERE package_url = ''");
if(is_array($incomplete_pkgs) && !empty($incomplete_pkgs)){
foreach($incomplete_pkgs as $incomplete_pkg){
$pkg_url = @file_get_contents($this->interface_pkg_dir.'/'.$incomplete_pkg['path'].'/PKG_URL');
if($pkg_url != ''){
$app->db->datalogUpdate('aps_packages', "package_url = '".$pkg_url."'", 'id', $incomplete_pkg['id']);
}
}
}
}
catch(Exception $e)
{
$app->log($this->log_prefix.$e->getMessage(), LOGLEVEL_ERROR);
$app->error($e->getMessage());
return false;
}
}
}