revamp all tools help messages

[apt.git] / apt-private / private-cmndline.cc

diff --git a/apt-private/private-cmndline.cc b/apt-private/private-cmndline.cc
index 1072b9a78b0d113fb8389c3c47d619302cc28603..4231c4f0ef82088ca2513ebf43d7bb3ca00d6c35 100644 (file)
--- a/apt-private/private-cmndline.cc
+++ b/apt-private/private-cmndline.cc
@@ -3,17 +3,21 @@
 
 #include <apt-pkg/cmndline.h>
 #include <apt-pkg/configuration.h>
 
 #include <apt-pkg/cmndline.h>
 #include <apt-pkg/configuration.h>

+#include <apt-pkg/fileutl.h>

 #include <apt-pkg/pkgsystem.h>
 #include <apt-pkg/init.h>
 #include <apt-pkg/error.h>
 #include <apt-pkg/pkgsystem.h>
 #include <apt-pkg/init.h>
 #include <apt-pkg/error.h>

+#include <apt-pkg/strutl.h>

 
 #include <apt-private/private-cmndline.h>
 
 
 #include <apt-private/private-cmndline.h>
 

-#include <vector>

 #include <stdarg.h>
 #include <string.h>
 #include <stdlib.h>
 
 #include <stdarg.h>
 #include <string.h>
 #include <stdlib.h>
 

+#include <vector>
+#include <iomanip>
+

 #include <apti18n.h>
                                                                        /*}}}*/
 
 #include <apti18n.h>
                                                                        /*}}}*/
 


@@ -123,6 +127,37 @@ static bool addArgumentsAPTConfig(std::vector<CommandLine::Args> &Args, char con
    else
       return false;
 
    else
       return false;
 

+   return true;
+}
+                                                                       /*}}}*/
+static bool addArgumentsAPTExtractTemplates(std::vector<CommandLine::Args> &Args, char const * const)/*{{{*/
+{
+   addArg('t',"tempdir","APT::ExtractTemplates::TempDir",CommandLine::HasArg);
+   return true;
+}
+                                                                       /*}}}*/
+static bool addArgumentsAPTFTPArchive(std::vector<CommandLine::Args> &Args, char const * const)/*{{{*/
+{
+   addArg(0,"md5","APT::FTPArchive::MD5",0);
+   addArg(0,"sha1","APT::FTPArchive::SHA1",0);
+   addArg(0,"sha256","APT::FTPArchive::SHA256",0);
+   addArg(0,"sha512","APT::FTPArchive::SHA512",0);
+   addArg('d',"db","APT::FTPArchive::DB",CommandLine::HasArg);
+   addArg('s',"source-override","APT::FTPArchive::SourceOverride",CommandLine::HasArg);
+   addArg(0,"delink","APT::FTPArchive::DeLinkAct",0);
+   addArg(0,"readonly","APT::FTPArchive::ReadOnlyDB",0);
+   addArg(0,"contents","APT::FTPArchive::Contents",0);
+   addArg('a',"arch","APT::FTPArchive::Architecture",CommandLine::HasArg);
+   return true;
+}
+                                                                       /*}}}*/
+static bool addArgumentsAPTInternalSolver(std::vector<CommandLine::Args> &, char const * const)/*{{{*/
+{
+   return true;
+}
+                                                                       /*}}}*/
+static bool addArgumentsAPTHelper(std::vector<CommandLine::Args> &, char const * const)/*{{{*/
+{

    return true;
 }
                                                                        /*}}}*/
    return true;
 }
                                                                        /*}}}*/


@@ -227,20 +262,38 @@ static bool addArgumentsAPTGet(std::vector<CommandLine::Args> &Args, char const
 static bool addArgumentsAPTMark(std::vector<CommandLine::Args> &Args, char const * const Cmd)/*{{{*/
 {
    if (CmdMatches("auto", "manual", "hold", "unhold", "showauto",
 static bool addArgumentsAPTMark(std::vector<CommandLine::Args> &Args, char const * const Cmd)/*{{{*/
 {
    if (CmdMatches("auto", "manual", "hold", "unhold", "showauto",

-           "showmanual", "showhold", "showholds", "install",
+           "showmanual", "showhold", "showholds",

            "markauto", "unmarkauto"))
            "markauto", "unmarkauto"))

+   {
+      addArg('f',"file","Dir::State::extended_states",CommandLine::HasArg);
+   }
+   else if (CmdMatches("install", "remove", "deinstall", "purge",
+           "showinstall", "showinstalls", "showremove", "showremoves",
+           "showdeinstall", "showdeinstalls", "showpurge", "showpurges"))

       ;
    else
       return false;
 
       ;
    else
       return false;
 

-   addArg('v',"verbose","APT::MarkAuto::Verbose",0);
-   addArg('s',"simulate","APT::Mark::Simulate",0);
-   addArg('s',"just-print","APT::Mark::Simulate",0);
-   addArg('s',"recon","APT::Mark::Simulate",0);
-   addArg('s',"dry-run","APT::Mark::Simulate",0);
-   addArg('s',"no-act","APT::Mark::Simulate",0);
-   addArg('f',"file","Dir::State::extended_states",CommandLine::HasArg);
+   if (CmdMatches("markauto", "unmarkauto"))
+   {
+      addArg('v',"verbose","APT::MarkAuto::Verbose",0);
+   }

 
 

+   if (strncmp(Cmd, "show", strlen("show")) != 0)
+   {
+      addArg('s',"simulate","APT::Mark::Simulate",0);
+      addArg('s',"just-print","APT::Mark::Simulate",0);
+      addArg('s',"recon","APT::Mark::Simulate",0);
+      addArg('s',"dry-run","APT::Mark::Simulate",0);
+      addArg('s',"no-act","APT::Mark::Simulate",0);
+   }
+
+   return true;
+}
+                                                                       /*}}}*/
+static bool addArgumentsAPTSortPkgs(std::vector<CommandLine::Args> &Args, char const * const)/*{{{*/
+{
+   addArg('s',"source","APT::SortPkgs::Source",0);

    return true;
 }
                                                                        /*}}}*/
    return true;
 }
                                                                        /*}}}*/


@@ -248,9 +301,9 @@ static bool addArgumentsAPT(std::vector<CommandLine::Args> &Args, char const * c
 {
    if (CmdMatches("list"))
    {
 {
    if (CmdMatches("list"))
    {

-      addArg(0,"installed","APT::Cmd::Installed",0);
+      addArg('i',"installed","APT::Cmd::Installed",0);

       addArg(0,"upgradeable","APT::Cmd::Upgradable",0);
       addArg(0,"upgradeable","APT::Cmd::Upgradable",0);

-      addArg(0,"upgradable","APT::Cmd::Upgradable",0);
+      addArg('u',"upgradable","APT::Cmd::Upgradable",0);

       addArg(0,"manual-installed","APT::Cmd::Manual-Installed",0);
       addArg('v', "verbose", "APT::Cmd::List-Include-Summary", 0);
       addArg('a', "all-versions", "APT::Cmd::All-Versions", 0);
       addArg(0,"manual-installed","APT::Cmd::Manual-Installed",0);
       addArg('v', "verbose", "APT::Cmd::List-Include-Summary", 0);
       addArg('a', "all-versions", "APT::Cmd::All-Versions", 0);


@@ -270,26 +323,32 @@ static bool addArgumentsAPT(std::vector<CommandLine::Args> &Args, char const * c
    return true;
 }
                                                                        /*}}}*/
    return true;
 }
                                                                        /*}}}*/

-std::vector<CommandLine::Args> getCommandArgs(char const * const Program, char const * const Cmd)/*{{{*/
+std::vector<CommandLine::Args> getCommandArgs(APT_CMD const Program, char const * const Cmd)/*{{{*/

 {
    std::vector<CommandLine::Args> Args;
    Args.reserve(50);
 {
    std::vector<CommandLine::Args> Args;
    Args.reserve(50);

-   if (Program == NULL || Cmd == NULL)
-      ; // FIXME: Invalid command supplied
+   if (Cmd == nullptr)
+   {
+      if (Program == APT_CMD::APT_EXTRACTTEMPLATES)
+        addArgumentsAPTExtractTemplates(Args, Cmd);
+   }

    else if (strcmp(Cmd, "help") == 0)
       ; // no options for help so no need to implement it in each
    else if (strcmp(Cmd, "help") == 0)
       ; // no options for help so no need to implement it in each

-   else if (strcmp(Program, "apt-get") == 0)
-      addArgumentsAPTGet(Args, Cmd);
-   else if (strcmp(Program, "apt-cache") == 0)
-      addArgumentsAPTCache(Args, Cmd);
-   else if (strcmp(Program, "apt-cdrom") == 0)
-      addArgumentsAPTCDROM(Args, Cmd);
-   else if (strcmp(Program, "apt-config") == 0)
-      addArgumentsAPTConfig(Args, Cmd);
-   else if (strcmp(Program, "apt-mark") == 0)
-      addArgumentsAPTMark(Args, Cmd);
-   else if (strcmp(Program, "apt") == 0)
-      addArgumentsAPT(Args, Cmd);
+   else
+      switch (Program)
+      {
+        case APT_CMD::APT: addArgumentsAPT(Args, Cmd); break;
+        case APT_CMD::APT_GET: addArgumentsAPTGet(Args, Cmd); break;
+        case APT_CMD::APT_CACHE: addArgumentsAPTCache(Args, Cmd); break;
+        case APT_CMD::APT_CDROM: addArgumentsAPTCDROM(Args, Cmd); break;
+        case APT_CMD::APT_CONFIG: addArgumentsAPTConfig(Args, Cmd); break;
+        case APT_CMD::APT_EXTRACTTEMPLATES: addArgumentsAPTExtractTemplates(Args, Cmd); break;
+        case APT_CMD::APT_FTPARCHIVE: addArgumentsAPTFTPArchive(Args, Cmd); break;
+        case APT_CMD::APT_HELPER: addArgumentsAPTHelper(Args, Cmd); break;
+        case APT_CMD::APT_INTERNAL_SOLVER: addArgumentsAPTInternalSolver(Args, Cmd); break;
+        case APT_CMD::APT_MARK: addArgumentsAPTMark(Args, Cmd); break;
+        case APT_CMD::APT_SORTPKG: addArgumentsAPTSortPkgs(Args, Cmd); break;
+      }

 
    // options without a command
    addArg('h', "help", "help", 0);
 
    // options without a command
    addArg('h', "help", "help", 0);


@@ -306,31 +365,152 @@ std::vector<CommandLine::Args> getCommandArgs(char const * const Program, char c
                                                                        /*}}}*/
 #undef CmdMatches
 #undef addArg
                                                                        /*}}}*/
 #undef CmdMatches
 #undef addArg

-void ParseCommandLine(CommandLine &CmdL, CommandLine::Dispatch * const Cmds, CommandLine::Args * const Args,/*{{{*/
-      Configuration * const * const Cnf, pkgSystem ** const Sys, int const argc, const char *argv[], bool(*ShowHelp)(CommandLine &CmdL))
+static void ShowHelpListCommands(std::vector<aptDispatchWithHelp> const &Cmds)/*{{{*/
+{
+   if (Cmds.empty() || Cmds[0].Match == nullptr)
+      return;
+   std::cout << std::endl << _("Most used commands:") << std::endl;
+   for (auto const &c: Cmds)
+   {
+      if (c.Help == nullptr)
+        continue;
+      std::cout << "  " << c.Match << " - " << c.Help << std::endl;
+   }
+}
+                                                                       /*}}}*/
+static bool ShowCommonHelp(APT_CMD const Binary, CommandLine &CmdL, std::vector<aptDispatchWithHelp> const &Cmds)/*{{{*/
+{
+   std::cout << PACKAGE << " " << PACKAGE_VERSION << " (" << COMMON_ARCH << ")" << std::endl;
+   if (_config->FindB("version") == true && Binary != APT_CMD::APT_GET)
+      return true;
+   if (ShowHelp(CmdL) == false)
+      return false;
+   if (_config->FindB("version") == true || Binary == APT_CMD::APT_FTPARCHIVE)
+      return true;
+   ShowHelpListCommands(Cmds);
+   std::cout << std::endl;
+   char const * cmd = nullptr;
+   switch (Binary)
+   {
+      case APT_CMD::APT: cmd = "apt(8)"; break;
+      case APT_CMD::APT_CACHE: cmd = "apt-cache(8)"; break;
+      case APT_CMD::APT_CDROM: cmd = "apt-cdrom(8)"; break;
+      case APT_CMD::APT_CONFIG: cmd = "apt-config(8)"; break;
+      case APT_CMD::APT_EXTRACTTEMPLATES: cmd = "apt-extracttemplates(1)"; break;
+      case APT_CMD::APT_FTPARCHIVE: cmd = "apt-ftparchive(1)"; break;
+      case APT_CMD::APT_GET: cmd = "apt-get(8)"; break;
+      case APT_CMD::APT_HELPER: cmd = nullptr; break;
+      case APT_CMD::APT_INTERNAL_SOLVER: cmd = nullptr; break;
+      case APT_CMD::APT_MARK: cmd = "apt-mark(8)"; break;
+      case APT_CMD::APT_SORTPKG: cmd = "apt-sortpkgs(1)"; break;
+   }
+   if (cmd != nullptr)
+      ioprintf(std::cout, _("See %s for more information about the available commands."), cmd);
+   std::cout << std::endl <<
+      _("Configuration options and syntax is detailed in apt.conf(5).\n"
+           "Information about how to configure sources can be found in sources.list(5).\n"
+           "Package and version choices can be expressed via apt_preferences(5).\n"
+           "Security details are available in apt-secure(8).\n");
+   if (Binary == APT_CMD::APT_GET || Binary == APT_CMD::APT)
+      std::cout << std::right << std::setw(70) << _("This APT has Super Cow Powers.") << std::endl;
+   else if (Binary == APT_CMD::APT_HELPER)
+      std::cout << std::right << std::setw(70) << _("This APT helper has Super Meep Powers.") << std::endl;
+   return true;
+}
+                                                                       /*}}}*/
+static void BinarySpecificConfiguration(char const * const Binary)     /*{{{*/
+{
+   std::string const binary = flNotDir(Binary);
+   if (binary == "apt" || binary == "apt-config")
+   {
+      _config->CndSet("Binary::apt::APT::Color", true);
+      _config->CndSet("Binary::apt::APT::Cache::Show::Version", 2);
+      _config->CndSet("Binary::apt::APT::Cache::AllVersions", false);
+      _config->CndSet("Binary::apt::APT::Cache::ShowVirtuals", true);
+      _config->CndSet("Binary::apt::APT::Cache::Search::Version", 2);
+      _config->CndSet("Binary::apt::APT::Cache::ShowDependencyType", true);
+      _config->CndSet("Binary::apt::APT::Cache::ShowVersion", true);
+      _config->CndSet("Binary::apt::APT::Get::Upgrade-Allow-New", true);
+      _config->CndSet("Binary::apt::APT::Cmd::Show-Update-Stats", true);
+      _config->CndSet("Binary::apt::DPkg::Progress-Fancy", true);
+      _config->CndSet("Binary::apt::Acquire::AllowInsecureRepositories", false);
+   }
+
+   _config->Set("Binary", binary);
+   std::string const conf = "Binary::" + binary;
+   _config->MoveSubTree(conf.c_str(), NULL);
+}
+                                                                       /*}}}*/
+std::vector<CommandLine::Dispatch> ParseCommandLine(CommandLine &CmdL, APT_CMD const Binary,/*{{{*/
+      Configuration * const * const Cnf, pkgSystem ** const Sys, int const argc, const char *argv[])

 {
 {

-   CmdL = CommandLine(Args,_config);
-   if ((Cnf != NULL && pkgInitConfig(**Cnf) == false) ||
-       CmdL.Parse(argc,argv) == false ||
+   if (Cnf != NULL && pkgInitConfig(**Cnf) == false)
+   {
+      _error->DumpErrors();
+      exit(100);
+   }
+
+   if (likely(argc != 0 && argv[0] != NULL))
+      BinarySpecificConfiguration(argv[0]);
+
+   std::vector<aptDispatchWithHelp> const CmdsWithHelp = GetCommands();
+   std::vector<CommandLine::Dispatch> Cmds;
+   if (CmdsWithHelp.empty() == false)
+   {
+      CommandLine::Dispatch const help = { "help", [](CommandLine &){return false;} };
+      Cmds.push_back(std::move(help));
+   }
+   for (auto const& cmd : CmdsWithHelp)
+      Cmds.push_back({cmd.Match, cmd.Handler});
+
+   // Args running out of scope invalidates the pointer stored in CmdL,
+   // but we don't use the pointer after this function, so we ignore
+   // this problem for now and figure something out if we have to.
+   std::vector<CommandLine::Args> Args;
+   if (Cmds.empty() == false && Cmds[0].Handler != nullptr)
+      Args = getCommandArgs(Binary, CommandLine::GetCommand(Cmds.data(), argc, argv));
+   else
+      Args = getCommandArgs(Binary, nullptr);
+   CmdL = CommandLine(Args.data(), _config);
+
+   if (CmdL.Parse(argc,argv) == false ||

        (Sys != NULL && pkgInitSystem(*_config, *Sys) == false))
    {
       if (_config->FindB("version") == true)
        (Sys != NULL && pkgInitSystem(*_config, *Sys) == false))
    {
       if (_config->FindB("version") == true)

-        ShowHelp(CmdL);
+        ShowCommonHelp(Binary, CmdL, CmdsWithHelp);

 
       _error->DumpErrors();
       exit(100);
    }
 
    // See if the help should be shown
 
       _error->DumpErrors();
       exit(100);
    }
 
    // See if the help should be shown

-   if (_config->FindB("help") == true || _config->FindB("version") == true)
+   if (_config->FindB("help") == true || _config->FindB("version") == true ||
+        (CmdL.FileSize() > 0 && strcmp(CmdL.FileList[0], "help") == 0))

    {
    {

-      ShowHelp(CmdL);
+      ShowCommonHelp(Binary, CmdL, CmdsWithHelp);

       exit(0);
    }
       exit(0);
    }

-   if (Cmds != NULL && CmdL.FileSize() == 0)
+   if (Cmds.empty() == false && CmdL.FileSize() == 0)

    {
    {

-      ShowHelp(CmdL);
+      ShowCommonHelp(Binary, CmdL, CmdsWithHelp);

       exit(1);
    }
       exit(1);
    }

+   return Cmds;
+}
+                                                                       /*}}}*/
+unsigned short DispatchCommandLine(CommandLine &CmdL, std::vector<CommandLine::Dispatch> const &Cmds)  /*{{{*/
+{
+   // Match the operation
+   bool const returned = Cmds.empty() ? true : CmdL.DispatchArg(Cmds.data());
+
+   // Print any errors or warnings found during parsing
+   bool const Errors = _error->PendingError();
+   if (_config->FindI("quiet",0) > 0)
+      _error->DumpErrors();
+   else
+      _error->DumpErrors(GlobalError::DEBUG);
+   if (returned == false)
+      return 100;
+   return Errors == true ? 100 : 0;

 }
                                                                        /*}}}*/
 }
                                                                        /*}}}*/