2 /**********************************************************************
3 Copyright (C) FrontAccounting, LLC.
4 Released under the terms of the GNU General Public License, GPL,
5 as published by the Free Software Foundation, either version 3
6 of the License, or (at your option) any later version.
7 This program is distributed in the hope that it will be useful,
8 but WITHOUT ANY WARRANTY; without even the implied warranty of
9 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10 See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
12 include_once($path_to_root. "/includes/archive.inc");
13 include_once($path_to_root. "/includes/remote_url.inc");
15 define('PKG_CACHE_PATH', $path_to_root.'/modules/_cache');
16 define('PUBKEY_PATH', $path_to_root);
17 define('REPO_URL', 'http://'.$repo_auth['login'].':'.$repo_auth['pass'].'@'.$repo_auth['host'].'/'.$repo_auth['branch']);
19 // FrontAccounting package class
21 class package extends gzip_file {
22 function package($filename, $basedir=null)
27 $basedir = PKG_CACHE_PATH.'/'.substr(basename($filename), 0, -4);
28 if (file_exists($basedir)) {
29 // flush_dir($basedir, true);
33 $this->archive($filename);
34 $this->set_options(array('basedir'=> $basedir));
35 $this->options['type'] = "pkg";
38 // Used by archive class. Use create_archive() instead.
42 return $this->create_gzip();
45 // Install package and clean temp directory.
53 $this->set_options(array('overwrite' => 1));
54 $this->extract_files(); // extract package in cache directory
55 $cachepath = $this->options['basedir'];
56 $ctrl = get_control_file("$cachepath/_init/config");
58 $targetdir = $path_to_root.'/'.$ctrl['InstallPath'];
60 if (!is_dir($targetdir))
63 $dpackage = new package("$cachepath/_data", $targetdir);
64 $dpackage->set_options(array('overwrite' => 1));
66 $flist = $dpackage->extract_files(true);
67 if (count($dpackage->error)) {
68 $this->error = array_merge($this->error, $dpackage->error);
71 copy_files($flist, $targetdir, "$cachepath/_back");
73 $dpackage->extract_files(); //install package in target directory
75 $success &= $this->support('install');
76 $success &= count($dpackage->error) == 0;
77 $this->error = array_merge($this->error, $dpackage->error);
81 // Removing package related sources
89 $cachepath = $this->options['basedir'];
90 $ctrl = get_control_file("$cachepath/_init/config");
92 $targetdir = $path_to_root.'/'.$ctrl['InstallPath'];
94 $dpackage = new package("$cachepath/_data", $targetdir);
96 $flist = $dpackage->extract_files(true);
98 $success &= copy_files($flist, "$cachepath/_back", $targetdir, true);
100 $success &= $this->support('uninstall');
105 // Purge all package related configuration and data.
113 // Call special function defined in package install class
115 function support($name, $params = null)
117 $cachepath = $this->options['basedir'];
118 if (file_exists("$cachepath/_init/init.php")) {
119 include("$cachepath/_init/init.php");
120 if (method_exists($installer, $name)) {
121 set_include_path("$cachepath/_init".PATH_SEPARATOR.get_include_path());
123 $ret = $installer->$name($params);
131 // Changes field value read from control file (single, or multiline) into
132 // arrays of subfields if needed.
134 function ufmt_property($key, $value)
136 // indexes used in output arrays
138 'MenuTabs' => array('url', 'access', 'tab_id', 'title', 'section'),
139 'MenuEntries' => array('url', 'access', 'tab_id', 'title'),
141 if (!isset($sub_fields[$key]))
142 return $value==='' ? null : $value;
146 if (!is_array($value))
147 $value = array($value);
148 foreach($value as $line) {
149 $indexes = $sub_fields[$key];
151 preg_match_all('/(["])(?:\\\\?+.)*?\1|[^"\s][\S]*/', $line, $match);
152 foreach($match[0] as $n => $subf) {
154 $val = strtr(substr($subf, 1, -1),
159 $ret[array_shift($indexes)] = $val;
168 //=============================================================================
170 // Retrieve control file and return as associative array
171 // $index is name of field used as key in result array, or null for numeric keys
173 function get_control_file($file, $index = false) {
175 $list = gzopen($file, 'rb');
176 if (!$list) return null;
178 $repo = $pkg = array();
179 $key = false; $value = '';
182 $line = rtrim($line);
183 if ($line && ctype_space($line[0])) { // continuation of multiline property
184 if (strlen(ltrim($line))) {
185 if ($value !== '' && !is_array($value))
186 $value = array($value);
187 $value[] = ltrim($line);
191 if ($key) { // save previous property if any
192 $pkg[$key] = ufmt_property($key, $value);
194 if (!strlen($line)) { // end of section
196 if ($index !== true) {
197 if ($index === false) break;
198 if (!isset($pkg[$index])) {
199 display_error(_("No key field '$index' in file '$file'"));
202 $repo[$pkg[$index]] = $pkg;
207 $key = null; $value = '';
209 } elseif (preg_match('/([^:]*):\s*(.*)/', $line, $m)) {
210 $key = $m[1]; $value = $m[2];
212 display_error("Empty key in line $line");
216 display_error("File parse error in line $line");
220 } while ((($line = fgets($list))!==false) || $key);
223 return $index === false ? $pkg : $repo;
226 // Save configuration data to control file.
228 function save_control_file($fname, $list, $zip=false)
230 $file = $zip ? gzopen($fname, 'wb') : fopen($fname, 'wb');
231 foreach($list as $section) {
232 foreach($section as $key => $value) {
233 if (is_array($value)) { // multiline value
234 if (is_array(reset($value))) { // lines have subfields
235 foreach($value as $i => $line) {
236 // Subfields containing white spaces or double quotes are doublequoted
237 // with " escaped with backslash.
238 foreach($line as $n => $subfield)
239 if (preg_match('/[\s"]/', $subfield)) {
241 '"'.strtr($subfield, array('"'=>'\\"')).'"';
243 // Subfields are separated by white space.
244 $value[$i] = implode(' ', $value[$i]);
247 // array elements on subsequent lines starting with white space
248 $value = implode("\n ", $value);
250 $zip ? gzwrite($file, "$key: $value\n") : fwrite($file, "$key: $value\n");
252 $zip ? gzwrite($file, "\n"): fwrite($file, "\n");
254 $zip ? gzclose($file) : fclose($file);
257 // Retrieve text field in localized version or default one
258 // when the localized is not avaialable.
260 function pkg_prop($pkg, $property, $lang=false)
263 if ($lang && isset($pkg[$property.'-'.user_language()]))
264 $prop = @$pkg[$pname];
266 $prop = @$pkg[$property];
268 return is_array($prop) ? implode("\n ",$prop): $prop;
271 // Retrieve list of packages from repository and return as table ($pkgname==null),
272 // or find $pkgname package in repository and optionaly download
274 // $type is type/s of package
275 // $filter is optional field selection array in form field=>newkey
276 // or (0=>field1, 1=>field2...)
277 // $outkey - field used as a key in package list. If null 'Package' field is used.
279 function get_pkg_or_list($type = null, $pkgname = null, $filter=array(), $outkey=null, $download=true) {
281 global $path_to_root, $repo_auth;
283 // first download local copy of repo release file
284 // and check remote signature with local copy of public key
286 $loclist = PKG_CACHE_PATH.'/Release.gz';
288 if (isset($type) && !is_array($type)) {
289 $type = array($type);
293 if (!file_exists($loclist)) {
294 url_copy(REPO_URL.'/Release.gz', $loclist);
297 $sig = url_get_contents(REPO_URL.'/Release.sig');
298 $data = file_get_contents($loclist);
299 $cert = file_get_contents(PUBKEY_PATH.'/FA.pem');
300 if (!openssl_verify($data, $sig, $cert)) {
304 display_error(_('Release file in repository is invalid, or public key is outdated.'));
311 $Release = get_control_file($loclist, 'Filename');
312 // download and check all indexes containing given package types
313 // then complete package list or seek for pkg
315 foreach($Release as $fname => $parms) {
316 if ($type && !count(array_intersect(explode(' ', $parms['Type']), $type))) {
317 unset($Release[$fname]); continue; // no packages of selected type in this index
319 if ($Release[$fname]['Version'] != $repo_auth['branch']) {
320 display_warning(_('Repository version does not match application version.')); // ?
322 $remoteindex = REPO_URL.'/'.$fname;
323 $locindex = PKG_CACHE_PATH.'/'.$fname;
326 if (!file_exists($locindex)) {
327 url_copy($remoteindex, $locindex);
330 if ($parms['SHA1sum'] != sha1_file($locindex)) { // check subdir index consistency
334 display_error(sprintf( _("Security alert: broken index file in repository '%s'. Please inform repository administrator about this issue."),
342 // scan subdir list and select packages of given type
343 $pkglist = get_control_file($locindex, 'Package');
344 foreach($pkglist as $name => $pkg) {
345 $pkgfullname = REPO_URL.'/'.$parms['Path']."/".$pkg['Filename'].'.pkg';
346 if (!isset($type) || in_array($pkg['Type'], $type)) {
350 foreach($filter as $field => $key) {
351 if (is_numeric($field))
352 $p[$field] = @$pkg[$field];
354 $p[$key] = @$pkg[$field];
357 if ($pkgname == null) {
358 $Packages[$outkey ? $outkey : $name] = $p;
359 } elseif ($pkgname == $pkg['Package']) {
360 //download package to temp directory
362 $locname = "$path_to_root/tmp/".$pkg['Filename'].'.pkg';
363 url_copy($pkgfullname, $locname);
364 // checking sha1 hash is expensive proces, so chekc the package
365 // consistency just before downloading
366 if ($pkg['SHA1sum'] != sha1_file($locname)) {
367 display_error(sprintf( _("Security alert: broken package '%s' in repository. Please inform repository administrator about this issue."),
381 function get_package($pkgname, $type = null)
383 return get_pkg_or_list($type, $pkgname);
386 Returns full name of installed package, or null if package is not installed.
388 function installed_package($package)
390 $cache = opendir(PKG_CACHE_PATH);
392 while ($file = @readdir($cache)) {
393 if (!is_dir(PKG_CACHE_PATH.'/'.$file))
395 if (strpos($file, $package.'-') === 0)
403 Remove package from system
405 function uninstall_package($name)
407 $name = installed_package($name);
408 if (!$name) return true; // not installed
409 $pkg = new package($name.'.pkg');
412 flush_dir(PKG_CACHE_PATH.'/'.$name, true);
413 rmdir(PKG_CACHE_PATH.'/'.$name);
415 return count($pkg->error)==0;
418 //---------------------------------------------------------------------------------------
420 // Return merged list of available and installed languages in inform of local
421 // configuration array supplemented with installed versions information.
423 function get_languages_list()
425 global $installed_languages;
427 $pkgs = get_pkg_or_list('language', null, array(
428 'Package' => 'package',
429 'Version' => 'available',
431 'Language' => 'code',
432 'Encoding' => 'encoding',
434 'Description' => 'Descr',
435 'InstallPath' => 'path'
438 // add/update languages already installed
440 foreach($installed_languages as $id => $l) {
441 $list = array_search_keys($l['code'], $pkgs, 'code'); // get all packages with this code
442 foreach ($list as $name) {
443 if ($l['encoding'] == $pkgs[$name]['encoding']) { // if the same encoding
444 $pkgs[$name]['version'] = @$l['version']; // set installed version
445 $pkgs[$name]['local_id'] = $id; // index in installed_languages
449 $l['local_id'] = $id;
450 if (!isset($l['package']) || $l['package'] == '' || !isset($pkgs[$l['package']]))
453 $pkgs[$l['package']] = array_merge($pkgs[$l['package']], $l);
458 //---------------------------------------------------------------------------------------
460 // Return merged list of available and installed extensions as a local
461 // configuration array supplemented with installed versions information.
463 function get_extensions_list($type = null)
466 if (isset($type) && !is_array($type)) {
467 $type = array($type);
470 $pkgs = get_pkg_or_list($type, null, array(
471 'Package' => 'package',
472 'Version' => 'available',
474 'Description' => 'Descr',
476 'DefaultStatus'=> 'active',
477 'MenuTabs' => 'tabs',
478 'MenuEntries' => 'entries',
479 'Encoding' => 'encoding',
480 'AccessExtensions' => 'acc_file',
481 'InstallPath' => 'path'
484 // add/update extensions already installed
486 $local = get_company_extensions();
487 foreach($local as $extno => $ext) {
488 if (!in_array($ext['type'], $type)) continue;
489 $ext['local_id'] = $extno;
490 if (!isset($pkgs[$ext['package']]) || $ext['package'] == '')
493 $pkgs[$ext['package']] = array_merge($pkgs[$ext['package']], $ext);
499 // Return merged list of available and installed extensions as a local
500 // configuration array supplemented with installed versions information.
502 function get_themes_list()
504 $pkgs = get_pkg_or_list('theme', null, array(
505 'Package' => 'package',
506 'Version' => 'available',
508 'Description' => 'Descr'
511 // add/update extensions already installed
513 $local = get_company_extensions();
515 foreach($local as $extno => $ext) {
516 if (isset($pkgs[@$ext['package']])) {
517 $ext['local_id'] = $extno;
518 $pkgs[$ext['package']] = array_merge($pkgs[$ext['package']], $ext);
521 // TODO: Add other themes from themes directory
526 //---------------------------------------------------------------------------------------
528 // Return merged list of available and installed COAs as a local
529 // configuration array supplemented with installed versions information.
531 function get_charts_list()
533 $pkgs = get_pkg_or_list('chart', null, array(
534 'Package' => 'package',
535 'Version' => 'available',
537 'Description' => 'Descr',
539 'InstallPath' => 'path',
540 'Encoding' => 'encoding',
544 // add/update default charts
546 $local = get_company_extensions();
548 foreach($local as $extno => $ext) {
549 if ($ext['type'] != 'chart') continue;
550 $ext['local_id'] = $extno;
551 if (!isset($pkgs[$ext['package']]) || $ext['package'] == '')
554 $pkgs[$ext['package']] = array_merge($pkgs[$ext['package']], $ext);
559 //---------------------------------------------------------------------------------------------
560 // Install/update package from repository
562 function install_language($pkg_name)
564 global $path_to_root, $installed_languages, $Ajax;
566 $pkg = get_pkg_or_list('language', $pkg_name);
569 $i = array_search_key($pkg['Language'], $installed_languages, 'code');
571 $i = count($installed_languages);
572 else { // remove another already installed package for this language
573 $old_pkg = @$installed_languages[$i]['package'];
574 if ($old_pkg && ($pkg['Package'] != $old_pkg))
575 uninstall_package($old_pkg);
578 $package = new package("$path_to_root/tmp/".$pkg['Filename'].'.pkg');
579 if ($package->install()) {
581 'name' => $pkg['Name'],
582 'package' => $pkg['Package'],
583 'code' => $pkg['Language'],
584 'encoding' => $pkg['Encoding'],
585 'version' => $pkg['Version'],
586 'path' => $pkg['InstallPath']
588 if ($pkg['RTLDir']=='yes')
590 $installed_languages[$i] = $lang;
591 write_lang($installed_languages);
592 unlink("$path_to_root/tmp/".$pkg['Filename'].'.pkg');
593 $Ajax->activate('lang_tbl');
595 display_error(implode('<br>', $package->error));
599 display_error(sprintf(_("Package '%s' not found."), $pkg_name));
604 //---------------------------------------------------------------------------------------------
605 // Install/update extension or theme package from repository
607 function install_extension($pkg_name)
609 global $path_to_root, $next_extension_id, $Ajax;
611 $pkg = get_pkg_or_list(array('extension', 'theme', 'chart'), $pkg_name);
613 $package = new package("$path_to_root/tmp/".$pkg['Filename'].'.pkg');
614 $local_exts = get_company_extensions();
615 if ($package->install()) {
616 $ext_id = array_search_key($pkg['Package'], $local_exts, 'package');
617 if ($ext_id === null)
618 $ext_id = $next_extension_id++;
620 'name' => $pkg['Name'],
621 'package' => $pkg['Package'],
622 'version' => $pkg['Version'],
623 'type' => $pkg['Type'],
625 'path' => $pkg['InstallPath'],
627 if (isset($pkg['MenuTabs']))
628 $ext['tabs'] = $pkg['MenuTabs'];
629 if (isset($pkg['MenuEntries']))
630 $ext['entries'] = $pkg['MenuEntries'];
631 if (isset($pkg['AccessExtensions']))
632 $ext['acc_file'] = $pkg['AccessExtensions'];
633 if (isset($pkg['SqlScript']))
634 $ext['sql'] = $pkg['SqlScript'];
635 $local_exts[$ext_id] = $ext;
636 $ret = update_extensions($local_exts);
637 unlink("$path_to_root/tmp/".$pkg['Filename'].'.pkg');
638 $Ajax->activate('ext_tbl');
641 display_error(implode('<br>', $package->error));
645 display_error(sprintf(_("Package '%s' not found."), $pkg_name));
651 Returns true if newer package version is available
653 function check_pkg_upgrade($current, $available)
655 preg_match_all('/[\d]+/', $available, $aver);
656 if (!count($aver[0]))
658 preg_match_all('/[\d]+/', $current, $cver);
659 if (!count($cver[0]))
661 foreach($aver[0] as $n => $ver)
662 if ($ver>@$cver[0][$n])
668 // Returns package info from index file
670 function get_package_info($pkg, $type=null, $filter=array(), $outkey=null, $download=true) {
671 return get_pkg_or_list($type, $pkg, $filter, null, false);