Code

Updated posix plugin/template
[gosa.git] / gosa-core / update-gosa
index 89b83232d80e7426496901c994c88cf9b6946396..55214d133d92abce2ba557858b96896ab11558e8 100755 (executable)
@@ -1,32 +1,66 @@
-#!/usr/bin/php5
+#!/usr/bin/php
 <?php
-
-define ("LOCALE_DIR", dirname(__FILE__)."/locale");
-define ("PLUGSTATE_DIR", "/tmp/gosa");
+/*
+ * This code is part of GOsa (http://www.gosa-project.org)
+ * Copyright (C) 2003-2008 GONICUS GmbH
+ *
+ * ID: $$Id: main.php 9254 2008-03-03 15:57:49Z cajus $$
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+define ("GOSA_HOME", dirname(__FILE__));
+define ("LOCALE_DIR", GOSA_HOME."/locale");
+define ("PLUGSTATE_DIR", GOSA_HOME."/state");
 
 function print_usage()
 {
        ?>
 update-gosa - class cache updated and plugin manager for GOsa
-Usage: update-gosa                        Update the class cache
-
-       update-gosa install-plugin dir     Install the plugin placed in "dir" to
-                                          the GOsa tree.
+Usage: update-gosa install dsc     Install the plugin using the dsc information
+                                   placed in the plugin source directory.
 
-       update-gosa remove-plugin plugin   Remove the plugin named "plugin" from
-                                          the current configuration.
+       update-gosa remove plugin   Remove the plugin named "plugin" from
+                                   the current configuration.
 
-       update-gosa list-plugins           Lists installed plugins
+       update-gosa list           Lists installed plugins
 
-       update-gosa rescan-i18n            Rebuilds the translations
+       update-gosa rescan-i18n     Rebuilds the translations
 
-       update-gosa rescan-classes         Rebuilds the class list
+       update-gosa rescan-classes  Rebuilds the class list
        
+       update-gosa                 Shortcut for rescan-classes and rescan-i18n
 <?php
        exit (1);
 }
 
 
+function rmdirRecursive($path, $followLinks=false) {
+  $dir= opendir($path);
+  while($entry= readdir($dir)) {
+    if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
+      unlink($path."/".$entry);
+    } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
+      rmdirRecursive($path."/".$entry);
+    }
+  }
+  closedir($dir);
+  return rmdir($path);
+}
+
+
 /* Function to include all class_ files starting at a given directory base */
 function get_classes($folder= ".")
 {
@@ -34,7 +68,11 @@ function get_classes($folder= ".")
   static $result= array();
 
   if ($base_dir == ""){
-    $base_dir= getcwd();
+    if ($folder == "."){
+      $base_dir= getcwd();
+    } else {
+      $base_dir= $folder;
+    }
   }
 
   $currdir=getcwd();
@@ -83,8 +121,9 @@ function get_classes($folder= ".")
 
 function rescan_classes()
 {
+       echo "Updating class cache...\n";
        $class_mapping= get_classes();
-       $filename= "include/class_location.inc";
+       $filename= GOSA_HOME."/include/class_location.inc";
 
        /* Sanity checks */
        if (!file_exists($filename) || is_writable($filename)) {
@@ -103,7 +142,7 @@ function rescan_classes()
        foreach ($class_mapping as $key => $value){
          fwrite ($handle, "                \"$key\" => \"$value\",\n");
        }
-       fwrite ($handle, " );\n?>");
+       fwrite ($handle, " );\n");
 
        fclose($handle);
 }
@@ -111,6 +150,7 @@ function rescan_classes()
 
 function rescan_i18n()
 {
+       echo "Updating internationalization...\n";
        $languages= array();
        $size= strlen(LOCALE_DIR);
 
@@ -137,7 +177,7 @@ function rescan_i18n()
                }
 
                /* Cat all these po files into one single file */
-               system ("(cd ".LOCALE_DIR." && msgcat ".implode(" ", $po_files)." > compiled/${language}/LC_MESSAGES/messages.po)", $val);
+               system ("(cd ".LOCALE_DIR." && msgcat --use-first ".implode(" ", $po_files)." > compiled/${language}/LC_MESSAGES/messages.po)", $val);
                if ($val != 0){
                        echo "Merging of message files failed - aborted";
                        exit (4);
@@ -148,12 +188,66 @@ function rescan_i18n()
                        exit (5);
                }
        }
+
+       echo "! Warning: you may need to reload your webservice!\n";
+}
+
+
+function rescan_guide()
+{
+       $master_guide= "doc/guide.xml";
+       echo "Updating Online Help Index...\n";
+       $master_guide_content="<?xml version=\"1.0\"?>\n".
+               "<!--\n".
+               "\tWARNING:\n".
+               "\tThis file is automatically generated by update-online-help.\n".
+               "\tIf you want to add entries, use doc/core/guide.xml or doc/plugins/\"Appropriate Plugin Directory\"/guide.xml.\n".
+               "\tThen execute update-online-help to merge them into this file.\n".
+               "-->\n\n".
+               "<!--\n".
+               "\tThis xml file specifies which class is documented in which help file.\n".
+               "\tIf isset ( \$_SESSION['current_class_for_help'] ) then open the helpfile which is\n".
+               "\tspecified for this class below.\n".
+               "-->\n\n".
+               "<!--\n".
+               "\t<ENTRY NAME='class name' VALUE='displayed text' PATH='path to helpfiles' FILE='path to htmlfile' />\n".
+               "\tLeave blank to display message \"There is no helpfile specified for this class.\"\n".
+               "-->\n".
+               "<ENTRIES>\n";
+
+       $guide= 'doc/core/guide.xml';
+       if(file_exists($guide) && is_readable($guide)) {
+               $master_guide_content.= file_get_contents($guide);
+       }
+       
+       if(file_exists('doc/plugins')) {
+               $plugins= scandir('doc/plugins');
+               foreach($plugins as $key => $plugin) {
+                       if($plugin != '.' && $plugin != '..') {
+                               if(is_dir('doc/plugins/'.$plugin)) {
+                                       $guide= 'doc/plugins/'.$plugin.'/guide.xml';
+                                       if(file_exists($guide) && is_readable($guide)) {
+                                               $master_guide_content.= file_get_contents($guide);
+                                       }
+                               }
+                       }
+               }
+       }
+
+       $master_guide_content.= "</ENTRIES>";
+       
+       $master_guide_content= preg_replace("/[ \t][ \t]*/", " ", $master_guide_content);
+
+       if((file_exists($master_guide) && is_writable($master_guide)) || is_writable('doc')) {
+               file_put_contents($master_guide, $master_guide_content);
+       }
+
 }
 
 
 function parse_ini($file)
 {
-       global $description, $provides, $depends;
+       global $description, $provides, $depends, $versions, $conflicts;
 
        $res= "";
        if (file_exists($file)){
@@ -161,13 +255,17 @@ function parse_ini($file)
 
                if (isset($tmp['gosa-plugin'])){
                        $plugin= &$tmp['gosa-plugin'];
-                       if (isset($plugin['name'])&& isset($plugin['description']) && isset($plugin['provides'])){
+                       if (isset($plugin['name'])&& isset($plugin['description'])){
                                $res= $plugin['name'];
-                               $provides[$res]= $plugin['provides'];
                                $description[$res]= $plugin['description'];
+                               $versions[$res]= $plugin['version'];
+                               $provides[$res]= $res;
                                if (isset($plugin['depends'])){
                                        $depends[$res]= explode(',', preg_replace('/\s+/', '', $plugin['depends']));
                                }
+                               if (isset($plugin['conflicts'])){
+                                       $conflicts[$res]= explode(',', preg_replace('/\s+/', '', $plugin['conflicts']));
+                               }
                        }
                }
        }
@@ -193,11 +291,17 @@ function dependency_check()
 
 function load_plugins()
 {
+       if (!is_dir(PLUGSTATE_DIR)){
+               if (!mkdir (PLUGSTATE_DIR, 0755, TRUE)){
+                       echo "Cannot create plugstate dir '".PLUGSTATE_DIR."' - aborted\n";
+                       exit (2);
+               }
+       }
        $dir= new DirectoryIterator(PLUGSTATE_DIR);
        foreach ($dir as $entry){
                if ($dir->isDir() && !preg_match('/^\./', $dir->__toString())){
                        $file= $dir->getPathName()."/plugin.dsc";
-                       if (!parse_ini($file)){
+                       if (parse_ini($file) == ""){
                                echo "! Warning: plugin ".$dir->getPathName()." is missing declarations\n";
                        }
                }
@@ -207,7 +311,7 @@ function load_plugins()
 
 function list_plugins()
 {
-       global $description;
+       global $description, $versions;
        $count= 0;
 
        /* Load plugin list */
@@ -216,10 +320,11 @@ function list_plugins()
        /* Show plugins */
        foreach ($description as $name => $dsc){
                if ($count == 0){
-                       echo "Plugin\t\t| Description\n";
-                       echo "------------------------------------------------------------------------\n";
+                       echo "Plugin\t\t|Version |Description\n";
+                       echo "----------------------------------------------------------------------------\n";
                }
-               echo "* $name\t\t| ".$dsc."\n";
+               $ver= $versions[$name];
+               echo "$name\t\t|$ver\t |$dsc\n";
                $count++;
        }
 
@@ -234,47 +339,219 @@ function list_plugins()
 }
 
 
-function install_plugin($name)
+function install_plugin($file)
 {
-       global $description, $provides, $depends;
+       global $description, $provides, $depends, $conflicts;
+
+       /* Load plugin list */
+       load_plugins();
+
+       /* Load .dsc file */
+       if (file_exists($file)){
+               $tmp= parse_ini_file($file, TRUE);
+
+               if (isset($tmp['gosa-plugin'])){
+                       $plugin= &$tmp['gosa-plugin'];
+                       if (isset($plugin['name'])&& isset($plugin['description'])){
+                               $name= $plugin['name'];
+                               $description= $plugin['description'];
+                               $depends= array();
+                               if (isset($plugin['depends'])){
+                                       $depends= explode(',', preg_replace('/\s+/', '', $plugin['depends']));
+                               }
+
+                               /* Already installed? */
+                               if (isset($provides[$name])){
+                                       echo "! Error: plugin already installed\n\n";
+                                       exit (3);
+                               }
+
+                               /* Check if dependencies are fullfilled */
+                               foreach ($depends as $dep){
+                                       $found= false;
+                                       foreach ($provides as $provide => $dummy){
+                                               if ($dep == $provide){
+                                                       $found= true;
+                                                       break;
+                                               }
+                                       }
+                                       if (!$found){
+                                               echo "! Error: plugin depends on '$dep', but this is not installed\n\n";
+                                               exit (3);
+                                       }
+                               }
+
+                               /* Check for conflicts */
+                               foreach ($conflicts as $conf){
+                                       if (!in_array($conf, $provides)){
+                                               echo "! Warning: plugin conflicts with '$conf'\n\n";
+                                       }
+                               }
+
+                               /* Create plugstate directory and touch plugin.lst */
+                               if (!mkdir (PLUGSTATE_DIR."/$name", 0755, TRUE)){
+                                       echo "Failed to create '".PLUGSTATE_DIR."/$name - aborted";
+                                       exit (3);
+                               }
+                               if (!$handle= fopen(PLUGSTATE_DIR."/$name/plugin.lst", 'w')) {
+                                       echo "Cannot open file '$filename' - aborted\n";
+                                       exit (1);
+                               }
+
+                               echo "Installing plugin '$name'...\n";
+
+                               /* Copy and fill plugin.lst */
+                               $path= dirname($file);
+                               $dir= new RecursiveDirectoryIterator($path);
+                               $all= new RecursiveIteratorIterator($dir);
+                               foreach ( $all as $entry ){
+                                       $source= $path."/".substr($entry->getPathName(), strlen($path) + 1);
+
+                                       /* Skip description - it belongs to the state dir */
+                                       if (preg_match('/\/plugin.dsc$/', $source)){
+                                               copy ($source, PLUGSTATE_DIR."/$name/plugin.dsc");
+                                               continue;
+                                       }
+
+                                       /* Skip well known directories */
+                                       if (preg_match('/^\.+$/', $source) || preg_match('/\/\.svn\//', $source)) {
+                                               continue;
+                                       }
+
+                                       /* Calculate destination */
+                                       if (preg_match("%^.*locale/%", $source)){
+                                               $dest= GOSA_HOME."/locale/plugins/$name/".preg_replace("%^.*locale/%", "", $source);
+                                       } elseif (preg_match("%^.*help/%", $source)) {
+                                               $dest= GOSA_HOME."/doc/plugins/$name/".preg_replace("%^.*help/%", "", $source);
+                                       } elseif (preg_match("%^.*html/%", $source)) {
+                                               $dest= GOSA_HOME."/html/plugins/$name/".preg_replace("%^.*html/%", "", $source);
+                                       } else {
+                                               $dest= GOSA_HOME."/plugins/".substr($entry->getPathName(), strlen($path) + 1);
+                                       }
+
+                                       /* Destination exists in case of directories? */
+                                       if ($entry->isDir()){
+                                               if (!is_dir($dest)){
+                                                       mkdir($dest, 0755, TRUE);
+                                                       fwrite ($handle, "$dest\n");
+                                               }
+                                       } else {
+                                               if (!is_dir(dirname($dest))){
+                                                       mkdir(dirname($dest), 0755, TRUE);
+                                                       fwrite ($handle, dirname($dest)."\n");
+                                               }
+                                       }
+
+                                       /* Copy files */
+                                       if ($entry->isFile()){
+                                               copy ($source, $dest);
+                                       }
+
+                                       /* Note what we did... */
+                                       fwrite ($handle, "$dest\n");
+                               }
+
+                               fclose($handle);
+                       }
+               }
+       }
+       
+       /* Update caches */
+       rescan_classes();
+       rescan_i18n();
+       rescan_guide();
+}
+
+
+function remove_plugin($name)
+{
+       global $description, $depends;
 
        /* Load plugin list */
        load_plugins();
 
-       # go to the directory, load dsc file
-       # check if it already there
-       # check if all dependencies are fullfilled
-       # copy plugin
-       # update classlist
-       # update i18n
+       /* Present? */
+       if (!isset($description[$name])){
+               echo "! Error: cannot find a plugin named '$name'\n\n";
+               exit (1);
+       }
+
+       /* Depends? */
+       foreach ($depends as $sname => $pl_depends){
+               if (in_array($name, $pl_depends)){
+                       echo "! Error: plugin '$sname' depends on '$name' - cannot remove it\n\n";
+                       exit (1);
+               }
+       }
 
-       #if (isset($)){
-       #}
+       /* Load information */
+       if (!file_exists(PLUGSTATE_DIR."/$name/plugin.lst")){
+               echo "! Error: cannot remove plugin '$name' - no install history found\n\n";
+               exit (1);
+       }
+
+       echo "Removing plugin '$name'...\n";
+       $contents= file(PLUGSTATE_DIR."/$name/plugin.lst");
+       $cnv= array();
+       foreach($contents as $line){
+               $entry= chop($line);
+               $cnv[strlen($entry).":$entry"]= $entry;
+       }
+       krsort($cnv);
+
+       /* Remove files first */
+       clearstatcache();
+       foreach ($cnv as $entry){
+               if (is_dir($entry)){
+                       rmdir($entry);
+                       continue;
+               }
+               if (file_exists($entry)){
+                       unlink($entry);
+               }
+       }
+
+       /* Remove state directory for plugin */
+       rmdirRecursive(PLUGSTATE_DIR."/$name");
+
+       /* Update caches */
+       rescan_classes();
+       rescan_i18n();
+       rescan_guide();
 }
 
 
+
 /* Fill global values */
-$description= $provides= $depends= array();
+$description= $provides= $depends= $versions= $conflicts= array();
 
 /* Action specified? */
 if ($argc < 2){
-       print_usage();
+       rescan_classes();
+       rescan_i18n();
+       rescan_guide();
         exit (0);
 }
+
 switch ($argv[1]){
-        case 'install-plugin':
+        case 'install':
                 if (isset($argv[2])){
                        install_plugin($argv[2]);
                } else {
-                       echo "Usage: update-gosa install-plugin directory\n\n";
+                       echo "Usage: update-gosa install dsc-file\n\n";
                        exit (1);
                }
                 break;
-        case 'list-plugins':
+        case 'list':
                 list_plugins();
                 break;
-        case 'remove-plugin':
-                echo "remove\n";
+        case 'remove':
+                if (isset($argv[2])){
+                       remove_plugin($argv[2]);
+               } else {
+                       echo "Usage: update-gosa remove plugin-name\n\n";
+                       exit (1);
+               }
                 break;
         case 'rescan-i18n':
                 rescan_i18n();