CPackArchiveGenerator add component supports

Source/CPack/cmCPackArchiveGenerator.cxx

@@ -22,6 +22,7 @@
 #include <errno.h>
 
 #include <cmsys/SystemTools.hxx>
+#include <cmsys/Directory.hxx>
 #include <cm_libarchive.h>
 
 //----------------------------------------------------------------------
@@ -43,33 +44,198 @@ int cmCPackArchiveGenerator::InitializeInternal()
   this->SetOptionIfNotSet("CPACK_INCLUDE_TOPLEVEL_DIRECTORY", "1");
   return this->Superclass::InitializeInternal();
 }
+//----------------------------------------------------------------------
+int cmCPackArchiveGenerator::addOneComponentToArchive(cmArchiveWrite& archive,
+                             cmCPackComponent* component)
+{
+  cmCPackLogger(cmCPackLog::LOG_VERBOSE, "   - packaging component: "
+      << component->Name
+      << std::endl);
+  // Add the files of this component to the archive
+  std::string localToplevel(this->GetOption("CPACK_TEMPORARY_DIRECTORY"));
+  localToplevel += "/"+ component->Name;
+  std::string dir = cmSystemTools::GetCurrentWorkingDirectory();
+  // Change to local toplevel
+  cmSystemTools::ChangeDirectory(localToplevel.c_str());
+  std::vector<std::string>::const_iterator fileIt;
+  for (fileIt = component->Files.begin(); fileIt != component->Files.end(); ++fileIt )
+    {
+    cmCPackLogger(cmCPackLog::LOG_DEBUG,"Adding file: " << (*fileIt) << std::endl);
+    archive.Add(*fileIt);
+    if (!archive)
+      {
+      cmCPackLogger(cmCPackLog::LOG_ERROR, "ERROR while packaging files: "
+            << archive.GetError()
+            << std::endl);
+      return 0;
+      }
+    }
+  // Go back to previous dir
+  cmSystemTools::ChangeDirectory(dir.c_str());
+  return 1;
+}
 
+/*
+ * The macro will open/create a file 'filename'
+ * an declare and open the associated
+ * cmArchiveWrite 'archive' object.
+ */
+#define DECLARE_AND_OPEN_ARCHIVE(filename,archive) \
+cmGeneratedFileStream gf; \
+gf.Open(filename.c_str(), false, true); \
+if (!GenerateHeader(&gf)) \
+  { \
+   cmCPackLogger(cmCPackLog::LOG_ERROR, "Problem to generate Header for archive < " \
+            << filename \
+            << ">." << std::endl); \
+    return 0; \
+  } \
+cmArchiveWrite archive(gf,this->Compress, this->Archive); \
+if (!archive) \
+  { \
+  cmCPackLogger(cmCPackLog::LOG_ERROR, "Problem to create archive < " \
+     << filename \
+     << ">. ERROR =" \
+     << archive.GetError() \
+     << std::endl); \
+  return 0; \
+  }
+
+//----------------------------------------------------------------------
+int cmCPackArchiveGenerator::PackageComponents(bool ignoreComponentGroup)
+{
+  packageFileNames.clear();
+  // The default behavior is to have one package by component group
+  // unless CPACK_COMPONENTS_IGNORE_GROUP is specified.
+  if (!ignoreComponentGroup)
+    {
+    std::map<std::string, cmCPackComponentGroup>::iterator compGIt;
+    for (compGIt=this->ComponentGroups.begin();
+        compGIt!=this->ComponentGroups.end(); ++compGIt)
+      {
+      cmCPackLogger(cmCPackLog::LOG_VERBOSE, "Packaging component group: "
+          << compGIt->first
+          << std::endl);
+      // Begin the archive for this group
+      std::string packageFileName= std::string(toplevel);
+      packageFileName += "/"+std::string(this->GetOption("CPACK_PACKAGE_FILE_NAME"))+"-"+compGIt->first + this->GetOutputExtension();
+      // open a block in order to automatically close archive
+      // at the end of the block
+      {
+        DECLARE_AND_OPEN_ARCHIVE(packageFileName,archive);
+        // now iterate over the component of this group
+        std::vector<cmCPackComponent*>::iterator compIt;
+        for (compIt=(compGIt->second).Components.begin();
+            compIt!=(compGIt->second).Components.end();
+            ++compIt)
+          {
+          // Add the files of this component to the archive
+          addOneComponentToArchive(archive,*compIt);
+          }
+      }
+      // add the generated package to package file names list
+      packageFileNames.push_back(packageFileName);
+      }
+    }
+  // CPACK_COMPONENTS_IGNORE_GROUPS is set
+  // We build 1 package per component
+  else
+    {
+    std::map<std::string, cmCPackComponent>::iterator compIt;
+    for (compIt=this->Components.begin();compIt!=this->Components.end(); ++compIt )
+      {
+      std::string localToplevel(this->GetOption("CPACK_TEMPORARY_DIRECTORY"));
+      std::string packageFileName = std::string(toplevel);
+
+      localToplevel += "/"+ compIt->first;
+      packageFileName += "/"+std::string(this->GetOption("CPACK_PACKAGE_FILE_NAME"))+"-"+compIt->first + this->GetOutputExtension();
+      {
+        DECLARE_AND_OPEN_ARCHIVE(packageFileName,archive);
+        // Add the files of this component to the archive
+        addOneComponentToArchive(archive,&(compIt->second));
+      }
+      // add the generated package to package file names list
+      packageFileNames.push_back(packageFileName);
+      }
+    }
+  return 1;
+}
+
+//----------------------------------------------------------------------
+int cmCPackArchiveGenerator::PackageComponentsAllInOne(bool allComponentInOne)
+{
+  // reset the package file names
+  packageFileNames.clear();
+  packageFileNames.push_back(std::string(toplevel));
+  packageFileNames[0] += "/"+std::string(this->GetOption("CPACK_PACKAGE_FILE_NAME"))+"-ALL" + this->GetOutputExtension();
+  cmCPackLogger(cmCPackLog::LOG_VERBOSE, "Packaging all groups in one package...(CPACK_COMPONENTS_ALL_GROUPS_IN_ONE_PACKAGE is set)"
+      << std::endl);
+  DECLARE_AND_OPEN_ARCHIVE(packageFileNames[0],archive);
+
+  // The ALL GROUP in ONE package case
+  if (! allComponentInOne) {
+    // iterate over the component groups
+    std::map<std::string, cmCPackComponentGroup>::iterator compGIt;
+    for (compGIt=this->ComponentGroups.begin();
+        compGIt!=this->ComponentGroups.end(); ++compGIt)
+      {
+      cmCPackLogger(cmCPackLog::LOG_VERBOSE, "Packaging component group: "
+          << compGIt->first
+          << std::endl);
+      // now iterate over the component of this group
+      std::vector<cmCPackComponent*>::iterator compIt;
+      for (compIt=(compGIt->second).Components.begin();
+          compIt!=(compGIt->second).Components.end();
+          ++compIt)
+        {
+        // Add the files of this component to the archive
+        addOneComponentToArchive(archive,*compIt);
+        }
+      }
+  }
+  // The ALL COMPONENT in ONE package case
+  else
+    {
+    std::map<std::string, cmCPackComponent>::iterator compIt;
+    for (compIt=this->Components.begin();compIt!=this->Components.end(); ++compIt )
+      {
+      // Add the files of this component to the archive
+      addOneComponentToArchive(archive,&(compIt->second));
+      }
+    }
+  // archive goes out of scope so it will finalized and closed.
+  return 1;
+}
+
+//----------------------------------------------------------------------
 int cmCPackArchiveGenerator::PackageFiles()
 {
   cmCPackLogger(cmCPackLog::LOG_DEBUG, "Toplevel: "
                 << toplevel << std::endl);
 
-  // Open binary stream
+  // The default behavior is to create 1 package by component group
-  cmGeneratedFileStream gf;
+  // unless the user asked to put all COMPONENTS in a single package
-  gf.Open(packageFileNames[0].c_str(), false, true);
+  bool allGroupInOne = (NULL != (this->GetOption("CPACK_COMPONENTS_ALL_GROUPS_IN_ONE_PACKAGE")));
-  // Add an eventual header to the archive
+  bool allComponentInOne = (NULL != (this->GetOption("CPACK_COMPONENTS_ALL_IN_ONE_PACKAGE")));
-  if (!GenerateHeader(&gf))
+  bool ignoreComponentGroup = ( NULL != (this->GetOption("CPACK_COMPONENTS_IGNORE_GROUPS")));
+  // CASE 1 : COMPONENT ALL-IN-ONE package
+  // If ALL GROUPS or ALL COMPONENTS in ONE package has been requested
+  // then the package file is unique and should be open here.
+  if ((allComponentInOne || allGroupInOne) && (!this->ComponentGroups.empty()))
     {
-    cmCPackLogger(cmCPackLog::LOG_ERROR, "Problem to generate Header for archive < "
+    return PackageComponentsAllInOne(allComponentInOne);
-        << packageFileNames[0]
-        << ">." << std::endl);
     }
-  // create a new archive
+  // CASE 2 : COMPONENT CLASSICAL package(s) (i.e. not all-in-one)
-  cmArchiveWrite archive(gf,this->Compress, this->Archive);
+  // There will be 1 package for each component group
-  if (!archive)
+  // however one may require to ignore component group and
+  // in this case you'll get 1 package for each component.
+  else if (!this->ComponentGroups.empty())
     {
-    cmCPackLogger(cmCPackLog::LOG_ERROR, "Problem to create archive < "
+    return PackageComponents(ignoreComponentGroup);
-                          << packageFileNames[0]
-                          << ">. ERROR ="
-                          << archive.GetError()
-                          << std::endl);
-    return 0;
     }
+
+  // CASE 3 : NON COMPONENT package.
+  DECLARE_AND_OPEN_ARCHIVE(packageFileNames[0],archive);
   std::vector<std::string>::const_iterator fileIt;
   std::string dir = cmSystemTools::GetCurrentWorkingDirectory();
   cmSystemTools::ChangeDirectory(toplevel.c_str());
@@ -99,3 +265,7 @@ int cmCPackArchiveGenerator::GenerateHeader(std::ostream*)
 {
   return 1;
 }
+
+bool cmCPackArchiveGenerator::SupportsComponentInstallation() const {
+  return true;
+}

Source/CPack/cmCPackArchiveGenerator.h

@@ -24,7 +24,7 @@
  *
  */
 class cmCPackArchiveGenerator : public cmCPackGenerator
-{
+  {
 public:
   cmTypeMacro(cmCPackArchiveGenerator, cmCPackGenerator);
 
@@ -35,13 +35,39 @@ public:
   virtual ~cmCPackArchiveGenerator();
   // Used to add a header to the archive 
   virtual int GenerateHeader(std::ostream* os);
-
+  // component support
+  virtual bool SupportsComponentInstallation() const;
 protected:
   virtual int InitializeInternal();
+  /**
+   * Add the files belonging to the specified component
+   * to the provided (already opened) archive.
+   * @param[in,out] archive the archive object
+   * @param[in] component the component whose file will be added to archive
+   */
+  int addOneComponentToArchive(cmArchiveWrite& archive, cmCPackComponent* component);
+
+  /**
+   * The main package file method.
+   * If component install was required this
+   * method will call either PackageComponents or
+   * PackageComponentsAllInOne.
+   */
   int PackageFiles();
+  /**
+   * The method used to package files when component
+   * install is used. This will create one
+   * archive for each component group.
+   */
+  int PackageComponents(bool ignoreComponentGroup);
+  /**
+   * Special case of component install where all
+   * components will be put in a single installer.
+   */
+  int PackageComponentsAllInOne(bool allComponentInOne);
   virtual const char* GetOutputExtension() = 0;
   cmArchiveWrite::Compress Compress;
   cmArchiveWrite::Type Archive;
-};
+  };
 
 #endif

Source/CPack/cmCPackGenerator.cxx

@@ -828,8 +828,8 @@ int cmCPackGenerator::DoPackage()
     return 0;
     }
 
-  cmCPackLogger(cmCPackLog::LOG_OUTPUT, "Compress package" << std::endl);
+  cmCPackLogger(cmCPackLog::LOG_OUTPUT, "Create package" << std::endl);
-  cmCPackLogger(cmCPackLog::LOG_VERBOSE, "Compress files to: "
+  cmCPackLogger(cmCPackLog::LOG_VERBOSE, "Package files to: "
     << (tempPackageFileName ? tempPackageFileName : "(NULL)") << std::endl);
   if ( cmSystemTools::FileExists(tempPackageFileName) )
     {
@@ -853,7 +853,10 @@ int cmCPackGenerator::DoPackage()
     std::vector<std::string>::const_iterator it;
     for ( it = files.begin(); it != files.end(); ++ it )
       {
-      std::string fileN = cmSystemTools::RelativePath(tempDirectory,
+      // beware we cannot just use tempDirectory as before
+      // because some generator will "CPACK_INCLUDE_TOPLEVEL_DIRECTORY"
+      // we really want "CPACK_TEMPORARY_DIRECTORY"
+      std::string fileN = cmSystemTools::RelativePath(this->GetOption("CPACK_TEMPORARY_DIRECTORY"),
                                                       it->c_str());
 
       // Determine which component we are in.
@@ -864,6 +867,7 @@ int cmCPackGenerator::DoPackage()
 
       // Add this file to the list of files for the component.
       this->Components[componentName].Files.push_back(fileN);
+      cmCPackLogger(cmCPackLog::LOG_DEBUG, "Adding file <" <<fileN<<"> to component <"<<componentName<<">"<<std::endl);
       }
     }