6e97e7d1cc8d787eae3e072287774278bdc4aeca
[fa-stable.git] / includes / packages.inc
1 <?php
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");
14 include_once($path_to_root. "/includes/hooks.inc");
15
16 define('PKG_CACHE_PATH', $path_to_root.'/modules/_cache');
17 define('PUBKEY_PATH', $path_to_root);
18 define('REPO_URL', 'http://'.$repo_auth['login'].':'.$repo_auth['pass'].'@'.$repo_auth['host'].'/'.$repo_auth['branch']);
19 //
20 // FrontAccounting package class
21 //
22 class package extends gzip_file {
23         function package($filename, $basedir=null)
24         {
25                 global $path_to_root;
26
27                 if (!$basedir) {
28                         $basedir = PKG_CACHE_PATH.'/'.substr(basename($filename), 0, -4);
29                         if (file_exists($basedir)) {
30 //                              flush_dir($basedir, true); 
31                         } else
32                         mkdir($basedir);
33                 }
34                 $this->archive($filename);
35                 $this->set_options(array('basedir'=> $basedir));
36                 $this->options['type'] = "pkg";
37         }
38         //
39         //      Used by archive class. Use create_archive() instead.
40         //      
41         function create_pkg() 
42         {
43                 return $this->create_gzip();
44         }
45         //
46         //      Install package and clean temp directory.
47         //
48         function install()
49         {
50                 global $path_to_root;
51                 
52                 $success = true;
53
54                 $this->set_options(array('overwrite' => 1));
55                 $this->extract_files(); // extract package in cache directory
56                 $cachepath = $this->options['basedir'];
57                 $ctrl = get_control_file("$cachepath/_init/config");
58
59                 $targetdir = $path_to_root.'/'.$ctrl['InstallPath'];
60
61                 if (!is_dir($targetdir))
62                         mkdir($targetdir);
63
64                 $dpackage = new package("$cachepath/_data", $targetdir);
65                 $dpackage->set_options(array('overwrite' => 1));
66
67                 $flist = $dpackage->extract_files(true);
68                 if (count($dpackage->error)) {
69                         $this->error = array_merge($this->error, $dpackage->error);
70                         return false;
71                 }
72                 copy_files($flist, $targetdir, "$cachepath/_back");
73         
74                 $dpackage->extract_files(); //install package in target directory
75
76                 $install = hook_invoke($ctrl['Package'], 'install_extension', $dummy);
77                 $success &= $install===null || $install;
78                 $success &= count($dpackage->error) == 0;
79                 $this->error = array_merge($this->error, $dpackage->error);
80                 return $success;
81         }
82         //
83         //      Removing package related sources
84         //
85         function uninstall()
86         {
87                 global $path_to_root;
88
89                 $success = true;
90
91                 $cachepath = $this->options['basedir'];
92                 $ctrl = get_control_file("$cachepath/_init/config");
93
94                 $targetdir = $path_to_root.'/'.$ctrl['InstallPath'];
95
96                 $dpackage = new package("$cachepath/_data", $targetdir);
97
98                 $flist = $dpackage->extract_files(true);
99
100                 $success &= copy_files($flist, "$cachepath/_back", $targetdir, true);
101
102                 if (strpos($ctrl['InstallPath'], 'modules/') === 0) { // flush module directory
103                         flush_dir($targetdir, true);
104                         rmdir($targetdir);
105                 }
106
107                 $uninstall = hook_invoke($ctrl['Package'], 'uninstall_extension', $dummy);
108                 $success &= $uninstall===null || $uninstall;
109
110                 return $success;
111         }
112         //
113         //      Purge all package related configuration and data.
114         //
115         function purge()
116         {
117                 return true;
118         }
119
120 }
121 //
122 // Changes field value read from control file (single, or multiline) into 
123 // arrays of subfields if needed.
124 //
125 function ufmt_property($key, $value)
126 {
127         // indexes used in output arrays
128         $sub_fields = array(
129 //              'MenuTabs' => array('url', 'access', 'tab_id', 'title', 'section'),
130 //              'MenuEntries' => array('url', 'access', 'tab_id', 'title'),
131         );
132         if (!isset($sub_fields[$key]))
133                 return $value==='' ? null : $value;
134
135         $prop = array();
136
137         if (!is_array($value))
138                 $value = array($value);
139         foreach($value as $line) {
140                 $indexes = $sub_fields[$key];
141                 $ret = array();
142                 preg_match_all('/(["])(?:\\\\?+.)*?\1|[^"\s][\S]*/', $line, $match);
143                 foreach($match[0] as $n => $subf) {
144                         if ($match[1][$n])
145                                 $val = strtr(substr($subf, 1, -1),
146                                         array('\\"'=>'"'));
147                 else
148                                 $val = $subf;
149                         if (count($indexes))
150                                 $ret[array_shift($indexes)] = $val;
151                         else
152                                 $ret[] = $val;
153                 }
154                 if (count($ret))
155                         $prop[] = $ret;
156         }
157         return $prop;
158 }
159 //=============================================================================
160 //
161 // Retrieve control file and return as associative array
162 //      $index is name of field used as key in result array, or null for numeric keys
163 //
164 function get_control_file($file, $index = false) {
165
166         $list = gzopen($file, 'rb');
167         if (!$list) return null;
168
169         $repo = $pkg = array();
170         $key = false; $value = '';
171         $line = '';
172         do {
173                 $line = rtrim($line);
174                 if ($line && ctype_space($line[0])) { // continuation of multiline property
175                         if (strlen(ltrim($line))) {
176                                 if ($value !== '' && !is_array($value))
177                                         $value = array($value);
178                                 $value[] = ltrim($line);
179                                 continue;
180                         }
181                 }
182                 if ($key) { // save previous property if any
183                         $pkg[$key] = ufmt_property($key, $value);
184                 }
185                 if (!strlen($line)) { // end of section
186                         if (count($pkg)) {
187                                 if ($index !== true) {
188                                         if ($index === false) break;
189                                         if (!isset($pkg[$index])) {
190                                                 display_error(sprintf(_("No key field '%s' in file '%s'"), $index, $file));
191                                                 return null;
192                                         }
193                                         $repo[$pkg[$index]] = $pkg;
194                                 } else
195                                         $repo[] = $pkg;
196                         }
197                         $pkg = array(); 
198                         $key = null; $value = '';
199                         continue;
200                 } elseif (preg_match('/([^:]*):\s*(.*)/', $line, $m)) {
201                         $key = $m[1]; $value = $m[2];
202                         if (!strlen($key)) {
203                                 display_error("Empty key in line $line");
204                                 return null;
205                         }
206                 } else {
207                         display_error("File parse error in line $line");
208                         return null;
209                 }
210                 
211         } while ((($line = fgets($list))!==false) || $key);
212         fclose($list);
213
214         return $index === false ? $pkg : $repo;
215 }
216 //
217 //      Save configuration data to control file.
218 //
219 function save_control_file($fname, $list, $zip=false) 
220 {
221         $file = $zip ?  gzopen($fname, 'wb') : fopen($fname, 'wb');
222         foreach($list as $section) {
223                 foreach($section as $key => $value) {
224                         if (is_array($value)) { // multiline value
225                                 if (is_array(reset($value))) { // lines have subfields
226                                         foreach($value as $i => $line) {
227                 // Subfields containing white spaces or double quotes are doublequoted 
228                 // with " escaped with backslash.
229                                                 foreach($line as $n => $subfield)
230                                                         if (preg_match('/[\s"]/', $subfield)) {
231                                                                 $value[$i][$n] = 
232                                                                         '"'.strtr($subfield, array('"'=>'\\"')).'"';
233                                                         }
234                                                 // Subfields are separated by white space.
235                                                 $value[$i] = implode(' ', $value[$i]);
236                                         }
237                                 }
238                                 // array elements on subsequent lines starting with white space
239                                 $value = implode("\n ", $value);
240                         }
241                         $zip ? gzwrite($file, "$key: $value\n") : fwrite($file, "$key: $value\n");
242                 }
243                 $zip ? gzwrite($file, "\n"): fwrite($file, "\n");
244         }
245         $zip ? gzclose($file) : fclose($file);
246 }
247 //
248 //      Retrieve text field in localized version or default one 
249 //      when the localized is not avaialable.
250 //
251 function pkg_prop($pkg, $property, $lang=false) 
252 {
253         
254         if ($lang && isset($pkg[$property.'-'.user_language()]))
255                 $prop = @$pkg[$pname];
256         else
257                 $prop = @$pkg[$property];
258
259         return is_array($prop) ? implode("\n ",$prop): $prop;
260 }
261 //
262 //      Retrieve list of packages from repository and return as table ($pkgname==null),
263 //      or find $pkgname package in repository and optionaly download
264 //
265 //      $type is type/s of package
266 //  $filter is optional field selection array in form field=>newkey
267 //              or (0=>field1, 1=>field2...)
268 //  $outkey - field used as a key in package list. If null 'Package' field is used.
269 //
270 function get_pkg_or_list($type = null, $pkgname = null, $filter=array(), $outkey=null, $download=true) {
271
272         global $path_to_root, $repo_auth;
273
274         // first download local copy of repo release file
275         // and check remote signature with local copy of public key
276         //
277         $loclist = PKG_CACHE_PATH.'/Release.gz';
278         
279         if (isset($type) && !is_array($type)) {
280                 $type = array($type);
281         }
282         $refresh = true;
283         do{
284                 if (!file_exists($loclist)) {
285                         url_copy(REPO_URL.'/Release.gz', $loclist);
286                         $refresh = false;
287                 }
288                 $sig = url_get_contents(REPO_URL.'/Release.sig');
289                 $data = file_get_contents($loclist);
290                 $cert = file_get_contents(PUBKEY_PATH.'/FA.pem');
291                 if (!openssl_verify($data, $sig, $cert)) {
292                         if ($refresh)
293                                 @unlink($loclist);
294                         else {
295                                 display_error(_('Release file in repository is invalid, or public key is outdated.'));
296                                 return null;
297                         }
298                 } else
299                         $refresh = false;
300         } while($refresh);
301
302         $Release = get_control_file($loclist, 'Filename');
303         // download and check all indexes containing given package types
304         // then complete package list or seek for pkg
305         $Packages = array();
306         foreach($Release as $fname => $parms) {
307                 if ($type && !count(array_intersect(explode(' ', $parms['Type']), $type))) {
308                         unset($Release[$fname]); continue; // no packages of selected type in this index
309                 }
310                 if ($Release[$fname]['Version'] != $repo_auth['branch']) {
311                         display_warning(_('Repository version does not match application version.')); // ?
312                 }
313                 $remoteindex = REPO_URL.'/'.$fname;
314                 $locindex = PKG_CACHE_PATH.'/'.$fname;
315                 $refresh = true;
316                 do{
317                         if (!file_exists($locindex)) { 
318                                 url_copy($remoteindex, $locindex);
319                                 $refresh = false;
320                         }
321                         if ($parms['SHA1sum'] != sha1_file($locindex)) {        // check subdir index consistency
322                                 if ($refresh)
323                                         @unlink($locindex);
324                                 else {
325                                         display_error(sprintf( _("Security alert: broken index file in repository '%s'. Please inform repository administrator about this issue."),
326                                                 $fname));
327                                         return null;
328                                 }
329                         } else
330                                 $refresh = false;
331                 } while($refresh);
332                 
333                  // scan subdir list and select packages of given type
334                 $pkglist = get_control_file($locindex, 'Package');
335                 foreach($pkglist as $name => $pkg) {
336                         $pkgfullname = REPO_URL.'/'.$parms['Path']."/".$pkg['Filename'].'.pkg';
337                         if (!isset($type) || in_array($pkg['Type'], $type)) {
338                                 if (empty($filter))
339                                         $p = $pkg;
340                                 else {
341                                         foreach($filter as $field => $key) {
342                                                 if (is_numeric($field))
343                                                         $p[$field] = @$pkg[$field];
344                                                 else
345                                                         $p[$key] = @$pkg[$field];
346                                         }
347                                 }
348                                 if ($pkgname == null) {
349                                         $Packages[$outkey ? $outkey : $name] = $p;
350                                 } elseif ($pkgname == $pkg['Package']) {
351                                         //download package to temp directory
352                                         if ($download) {
353                                                 $locname = "$path_to_root/tmp/".$pkg['Filename'].'.pkg';
354                                                 url_copy($pkgfullname, $locname);
355                                                  // checking sha1 hash is expensive proces, so chekc the package
356                                                  // consistency just before downloading
357                                                 if ($pkg['SHA1sum'] != sha1_file($locname)) {
358                                                         display_error(sprintf( _("Security alert: broken package '%s' in repository. Please inform repository administrator about this issue."),
359                                                                 $pkgfullname));
360                                                         return null;
361                                                 }
362                                         }
363                                         return $p;
364                                 }
365                         }
366                 }
367         }
368
369         return $Packages;
370 }
371
372 function get_package($pkgname, $type = null)
373 {
374         return get_pkg_or_list($type, $pkgname);
375 }
376 /*
377         Returns full name of installed package, or null if package is not installed.
378 */
379 function installed_package($package)
380 {
381         $cache = opendir(PKG_CACHE_PATH);
382
383         while ($file = @readdir($cache)) {
384                 if (!is_dir(PKG_CACHE_PATH.'/'.$file))
385                         continue;
386                 if (strpos($file, $package.'-') === 0)
387                         return $file;
388         }
389         @closedir($cache);
390
391         return null;
392 }
393 /*
394         Remove package from system
395 */
396 function uninstall_package($name)
397 {
398         $name = installed_package($name);
399         if (!$name) return true; // not installed
400         $pkg = new package($name.'.pkg');
401         $pkg->uninstall();
402         if($name) {
403                 flush_dir(PKG_CACHE_PATH.'/'.$name, true);
404                 rmdir(PKG_CACHE_PATH.'/'.$name);
405         }
406         return count($pkg->error)==0;
407 }
408
409 //---------------------------------------------------------------------------------------
410 //
411 //      Return merged list of available and installed languages in inform of local 
412 // configuration array supplemented with installed versions information.
413 //
414 function get_languages_list()
415 {
416         global $installed_languages;
417         
418         $pkgs = get_pkg_or_list('language', null, array(
419                                 'Package' => 'package',
420                                 'Version' => 'available',
421                                 'Name' => 'name',
422                                 'Language' => 'code',
423                                 'Encoding' => 'encoding',
424                                 'RTLDir' => 'rtl',
425                                 'Description' => 'Descr',
426                                 'InstallPath' => 'path'
427                         ));
428
429         // add/update languages already installed
430         // 
431         foreach($installed_languages as $id => $l) {
432                 $list = array_search_keys($l['code'], $pkgs, 'code');   // get all packages with this code
433                 foreach ($list as $name) {
434                         if ($l['encoding'] == $pkgs[$name]['encoding']) {       // if the same encoding
435                                 $pkgs[$name]['version'] = @$l['version'];               // set installed version
436                                 $pkgs[$name]['local_id'] = $id;         // index in installed_languages
437                                 continue 2;
438                         }
439                 }
440                 $l['local_id'] = $id;
441                 if (!isset($l['package']) || $l['package'] == '' || !isset($pkgs[$l['package']]))
442                         $pkgs[] = $l;
443                 else
444                         $pkgs[$l['package']] = array_merge($pkgs[$l['package']], $l);
445         }
446         ksort($pkgs);
447         return $pkgs;
448 }
449 //---------------------------------------------------------------------------------------
450 //
451 //      Return merged list of available and installed extensions as a local 
452 // configuration array supplemented with installed versions information.
453 //
454 function get_extensions_list($type = null)
455 {
456         global $path_to_root;
457
458         if (isset($type) || !is_array($type)) {
459                 $type = array($type);
460         }
461
462         $pkgs = get_pkg_or_list($type, null, array(
463                                 'Package' => 'package',
464                                 'Version' => 'available',
465                                 'Name' => 'name',
466                                 'Description' => 'Descr',
467                                 'Type' => 'type',
468                                 'DefaultStatus'=> 'active',
469 //                              'MenuTabs' => 'tabs',
470 //                              'MenuEntries' => 'entries',
471                                 'Encoding' => 'encoding',
472 //                              'AccessExtensions' => 'acc_file',
473                                 'InstallPath' => 'path'
474                         ));
475
476         // lookup for local extensions
477         $path = $path_to_root.'/modules/';
478         $loc = array();
479         $moddir = opendir($path);
480
481         while(false != ($fname = readdir($moddir)))
482         {
483                 if(!in_array($fname, array('.','..','CVS','_cache')) && is_dir($path.$fname))
484                 {
485                         if (!isset($pkgs[$fname]))
486                                 $pkgs[$fname] = array(
487                                         'package' => $fname,
488                                         'name' => $fname,
489                                         'version' => '',
490                                         'available' => '',
491                                         'type' => 'extension',
492                                         'path' => 'modules/'.$fname,
493                                         'active' => false
494                                         );
495                 }
496         }
497
498         // add/update extensions already installed
499         // 
500         $installed = get_company_extensions();
501         foreach($installed as $extno => $ext) {
502                 if (!in_array($ext['type'], $type)) continue;
503                 $ext['local_id'] = $extno;
504 //              if (!isset($pkgs[$ext['package']]) || $ext['package'] == '')
505 //                      $pkgs[] = $ext;
506 //              else
507                         $pkgs[$ext['package']] = array_merge($pkgs[$ext['package']], $ext);
508         }
509         ksort($pkgs);
510         return $pkgs;
511 }
512 //
513 // Return merged list of available and installed extensions as a local
514 // configuration array supplemented with installed versions information.
515 //
516 function get_themes_list()
517 {
518         $pkgs = get_pkg_or_list('theme', null, array(
519                                 'Package' => 'package',
520                                 'Version' => 'available',
521                                 'Name' => 'name',
522                                 'Description' => 'Descr'
523                         ));
524
525         // add/update extensions already installed
526         // 
527         $local = get_company_extensions();
528         
529         foreach($local as $extno => $ext) {
530                 if (isset($pkgs[@$ext['package']])) {
531                         $ext['local_id'] = $extno;
532                         $pkgs[$ext['package']] = array_merge($pkgs[$ext['package']], $ext);
533                 }
534         }
535         // TODO: Add other themes from themes directory
536         
537         ksort($pkgs);
538         return $pkgs;
539 }
540 //---------------------------------------------------------------------------------------
541 //
542 //      Return merged list of available and installed COAs as a local 
543 // configuration array supplemented with installed versions information.
544 //
545 function get_charts_list()
546 {
547         $pkgs = get_pkg_or_list('chart', null, array(
548                                 'Package' => 'package',
549                                 'Version' => 'available',
550                                 'Name' => 'name',
551                                 'Description' => 'Descr',
552                                 'Type' => 'type',
553                                 'InstallPath' => 'path',
554                                 'Encoding' => 'encoding',
555                                 'SqlScript' => 'sql'
556                         ));
557
558         // add/update default charts
559         // 
560         $local = get_company_extensions();
561
562         foreach($local as $extno => $ext) {
563                 if ($ext['type'] != 'chart') continue;
564                 $ext['local_id'] = $extno;
565                 if (!isset($pkgs[$ext['package']]) || $ext['package'] == '')
566                         $pkgs[] = $ext;
567                 else
568                         $pkgs[$ext['package']] = array_merge($pkgs[$ext['package']], $ext);
569         }
570         ksort($pkgs);
571         return $pkgs;
572 }
573 //---------------------------------------------------------------------------------------------
574 //      Install/update package from repository
575 //
576 function install_language($pkg_name)
577 {
578         global $path_to_root, $installed_languages, $Ajax;
579         
580         $pkg = get_pkg_or_list('language', $pkg_name);
581
582         if ($pkg) {
583                 $i = array_search_key($pkg['Language'], $installed_languages, 'code');
584                 if ($i === null)
585                         $i = count($installed_languages);
586                 else {  // remove another already installed package for this language 
587                         $old_pkg = @$installed_languages[$i]['package'];
588                         if ($old_pkg && ($pkg['Package'] != $old_pkg))
589                                 uninstall_package($old_pkg);
590                 }
591
592                 $package = new package("$path_to_root/tmp/".$pkg['Filename'].'.pkg');
593                 if ($package->install()) {
594                         $lang = array(
595                                 'name' => $pkg['Name'],
596                                 'package' => $pkg['Package'],
597                                 'code' => $pkg['Language'],
598                                 'encoding' => $pkg['Encoding'],
599                                 'version' => $pkg['Version'],
600                                 'path' => $pkg['InstallPath']
601                         );
602                         if ($pkg['RTLDir']=='yes')
603                                 $lang['rtl'] = true;
604                         $installed_languages[$i] = $lang;
605                         write_lang($installed_languages);
606                         unlink("$path_to_root/tmp/".$pkg['Filename'].'.pkg');
607                         $Ajax->activate('lang_tbl');
608                 } else {
609                         display_error(implode('<br>', $package->error));
610                         return false;
611                 }
612         } else {
613                 display_error(sprintf(_("Package '%s' not found."), $pkg_name));
614                 return false;
615         }
616         return true;
617 }
618 //---------------------------------------------------------------------------------------------
619 //      Install/update extension or theme package from repository
620 //
621 function install_extension($pkg_name)
622 {
623         global $path_to_root, $installed_extensions, $next_extension_id, $Ajax;
624         
625         $pkg = get_pkg_or_list(array('extension', 'theme', 'chart'), $pkg_name);
626         if ($pkg) {
627                 $package = new package("$path_to_root/tmp/".$pkg['Filename'].'.pkg');
628                 $local_exts = get_company_extensions();
629                 if ($package->install()) {
630                         $ext_id = array_search_key($pkg['Package'], $local_exts, 'package');
631                         if ($ext_id === null)
632                                 $ext_id = $next_extension_id++;
633                         else {  // remove another already installed package for this language 
634                                 $old_pkg = $installed_extensions[$ext_id]['package'];
635                                 if ($old_pkg)
636                                         uninstall_package($old_pkg);
637                         }
638                         $ext = array(
639                                 'name' => $pkg['Name'],
640                                 'package' => $pkg['Package'],
641                                 'version' => $pkg['Version'],
642                                 'type' => $pkg['Type'],
643                                 'active' => true,
644                                 'path' => $pkg['InstallPath'],
645                         );
646 //                      if (isset($pkg['MenuTabs']))
647 //                              $ext['tabs'] = $pkg['MenuTabs'];
648 //                      if (isset($pkg['MenuEntries']))
649 //                              $ext['entries'] = $pkg['MenuEntries'];
650 //                      if (isset($pkg['AccessExtensions']))
651 //                              $ext['acc_file'] = $pkg['AccessExtensions'];
652                         if (isset($pkg['SqlScript']))
653                                 $ext['sql'] = $pkg['SqlScript'];
654                         $local_exts[$ext_id] = $ext;
655                         $ret = update_extensions($local_exts);
656                         unlink("$path_to_root/tmp/".$pkg['Filename'].'.pkg');
657                         $Ajax->activate('ext_tbl');
658                         return $ret;
659                 } else {
660                         display_error(implode('<br>', $package->error));
661                         return false;
662                 }
663         } else {
664                 display_error(sprintf(_("Package '%s' not found."), $pkg_name));
665                 return false;
666         }
667         return true;
668 }
669 /*
670         Returns true if newer package version is available
671 */
672 function check_pkg_upgrade($current, $available)
673 {
674         preg_match_all('/[\d]+/', $available, $aver);
675         if (!count($aver[0]))
676                 return false;
677         preg_match_all('/[\d]+/', $current, $cver);
678         if (!count($cver[0]))
679                 return true;
680         foreach($aver[0] as $n => $ver)
681                 if ($ver>@$cver[0][$n]) 
682                         return true;
683         return false;
684 }
685
686 //
687 //      Returns package info from index file
688 //
689 function get_package_info($pkg, $type=null, $filter=array(), $outkey=null, $download=true) {
690         return get_pkg_or_list($type, $pkg, $filter, null, false);
691 }
692
693 ?>