apt-private/private-cmndline.cc

   1 // Include Files                                                        /*{{{*/
   2 #include <config.h>
   3
   4 #include <apt-pkg/cmndline.h>
   5 #include <apt-pkg/configuration.h>
   6 #include <apt-pkg/fileutl.h>
   7 #include <apt-pkg/pkgsystem.h>
   8 #include <apt-pkg/init.h>
   9 #include <apt-pkg/error.h>
  10
  11 #include <apt-private/private-cmndline.h>
  12
  13 #include <vector>
  14 #include <stdarg.h>
  15 #include <string.h>
  16 #include <stdlib.h>
  17
  18 #include <apti18n.h>
  19                                                                         /*}}}*/
  20
  21 APT_SENTINEL static bool strcmp_match_in_list(char const * const Cmd, ...)              /*{{{*/
  22 {
  23    va_list args;
  24    bool found = false;
  25    va_start(args, Cmd);
  26    char const * Match = NULL;
  27    while ((Match = va_arg(args, char const *)) != NULL)
  28    {
  29       if (strcmp(Cmd, Match) != 0)
  30          continue;
  31       found = true;
  32       break;
  33    }
  34    va_end(args);
  35    return found;
  36 }
  37                                                                         /*}}}*/
  38 #define addArg(w,x,y,z) Args.push_back(CommandLine::MakeArgs(w,x,y,z))
  39 #define CmdMatches(...) strcmp_match_in_list(Cmd, __VA_ARGS__, NULL)
  40 static bool addArgumentsAPTCache(std::vector<CommandLine::Args> &Args, char const * const Cmd)/*{{{*/
  41 {
  42    if (CmdMatches("depends", "rdepends", "xvcg", "dotty"))
  43    {
  44       addArg('i', "important", "APT::Cache::Important", 0);
  45       addArg(0, "installed", "APT::Cache::Installed", 0);
  46       addArg(0, "pre-depends", "APT::Cache::ShowPre-Depends", 0);
  47       addArg(0, "depends", "APT::Cache::ShowDepends", 0);
  48       addArg(0, "recommends", "APT::Cache::ShowRecommends", 0);
  49       addArg(0, "suggests", "APT::Cache::ShowSuggests", 0);
  50       addArg(0, "replaces", "APT::Cache::ShowReplaces", 0);
  51       addArg(0, "breaks", "APT::Cache::ShowBreaks", 0);
  52       addArg(0, "conflicts", "APT::Cache::ShowConflicts", 0);
  53       addArg(0, "enhances", "APT::Cache::ShowEnhances", 0);
  54       addArg(0, "recurse", "APT::Cache::RecurseDepends", 0);
  55       addArg(0, "implicit", "APT::Cache::ShowImplicit", 0);
  56    }
  57    else if (CmdMatches("search"))
  58    {
  59       addArg('n', "names-only", "APT::Cache::NamesOnly", 0);
  60       addArg('f', "full", "APT::Cache::ShowFull", 0);
  61    }
  62    else if (CmdMatches("show"))
  63    {
  64       addArg('a', "all-versions", "APT::Cache::AllVersions", 0);
  65    }
  66    else if (CmdMatches("pkgnames"))
  67    {
  68       addArg(0, "all-names", "APT::Cache::AllNames", 0);
  69    }
  70    else if (CmdMatches("unmet"))
  71    {
  72       addArg('i', "important", "APT::Cache::Important", 0);
  73    }
  74    else if (CmdMatches("showsrc"))
  75    {
  76       addArg(0,"only-source","APT::Cache::Only-Source",0);
  77    }
  78    else if (CmdMatches("gencaches", "showpkg", "stats", "dump",
  79             "dumpavail", "showauto", "policy", "madison"))
  80       ;
  81    else
  82       return false;
  83
  84    bool const found_something = Args.empty() == false;
  85
  86    // FIXME: move to the correct command(s)
  87    addArg('g', "generate", "APT::Cache::Generate", 0);
  88    addArg('t', "target-release", "APT::Default-Release", CommandLine::HasArg);
  89    addArg('t', "default-release", "APT::Default-Release", CommandLine::HasArg);
  90
  91    addArg('p', "pkg-cache", "Dir::Cache::pkgcache", CommandLine::HasArg);
  92    addArg('s', "src-cache", "Dir::Cache::srcpkgcache", CommandLine::HasArg);
  93
  94    return found_something;
  95 }
  96                                                                         /*}}}*/
  97 static bool addArgumentsAPTCDROM(std::vector<CommandLine::Args> &Args, char const * const Cmd)/*{{{*/
  98 {
  99    if (CmdMatches("add", "ident") == false)
 100       return false;
 101
 102    // FIXME: move to the correct command(s)
 103    addArg(0, "auto-detect", "Acquire::cdrom::AutoDetect", CommandLine::Boolean);
 104    addArg('d', "cdrom", "Acquire::cdrom::mount", CommandLine::HasArg);
 105    addArg('r', "rename", "APT::CDROM::Rename", 0);
 106    addArg('m', "no-mount", "APT::CDROM::NoMount", 0);
 107    addArg('f', "fast", "APT::CDROM::Fast", 0);
 108    addArg('n', "just-print", "APT::CDROM::NoAct", 0);
 109    addArg('n', "recon", "APT::CDROM::NoAct", 0);
 110    addArg('n', "no-act", "APT::CDROM::NoAct", 0);
 111    addArg('a', "thorough", "APT::CDROM::Thorough", 0);
 112    return true;
 113 }
 114                                                                         /*}}}*/
 115 static bool addArgumentsAPTConfig(std::vector<CommandLine::Args> &Args, char const * const Cmd)/*{{{*/
 116 {
 117    if (CmdMatches("dump"))
 118    {
 119       addArg(0,"empty","APT::Config::Dump::EmptyValue",CommandLine::Boolean);
 120       addArg(0,"format","APT::Config::Dump::Format",CommandLine::HasArg);
 121    }
 122    else if (CmdMatches("shell"))
 123       ;
 124    else
 125       return false;
 126
 127    return true;
 128 }
 129                                                                         /*}}}*/
 130 static bool addArgumentsAPTGet(std::vector<CommandLine::Args> &Args, char const * const Cmd)/*{{{*/
 131 {
 132    if (CmdMatches("install", "remove", "purge", "upgrade", "dist-upgrade",
 133             "dselect-upgrade", "autoremove", "full-upgrade"))
 134    {
 135       addArg(0, "show-progress", "DpkgPM::Progress", 0);
 136       addArg('f', "fix-broken", "APT::Get::Fix-Broken", 0);
 137       addArg(0, "purge", "APT::Get::Purge", 0);
 138       addArg('V',"verbose-versions","APT::Get::Show-Versions",0);
 139       addArg(0, "auto-remove", "APT::Get::AutomaticRemove", 0);
 140       addArg(0, "reinstall", "APT::Get::ReInstall", 0);
 141       addArg(0, "solver", "APT::Solver", CommandLine::HasArg);
 142       if (CmdMatches("upgrade"))
 143       {
 144          addArg(0, "new-pkgs", "APT::Get::Upgrade-Allow-New",
 145                 CommandLine::Boolean);
 146       }
 147    }
 148    else if (CmdMatches("update"))
 149    {
 150       addArg(0, "list-cleanup", "APT::Get::List-Cleanup", 0);
 151    }
 152    else if (CmdMatches("source"))
 153    {
 154       addArg('b', "compile", "APT::Get::Compile", 0);
 155       addArg('b', "build", "APT::Get::Compile", 0);
 156       addArg('P', "build-profiles", "APT::Build-Profiles", CommandLine::HasArg);
 157       addArg(0, "diff-only", "APT::Get::Diff-Only", 0);
 158       addArg(0, "debian-only", "APT::Get::Diff-Only", 0);
 159       addArg(0, "tar-only", "APT::Get::Tar-Only", 0);
 160       addArg(0, "dsc-only", "APT::Get::Dsc-Only", 0);
 161    }
 162    else if (CmdMatches("build-dep"))
 163    {
 164       addArg('a', "host-architecture", "APT::Get::Host-Architecture", CommandLine::HasArg);
 165       addArg('P', "build-profiles", "APT::Build-Profiles", CommandLine::HasArg);
 166       addArg(0, "purge", "APT::Get::Purge", 0);
 167       addArg(0, "solver", "APT::Solver", CommandLine::HasArg);
 168       // this has no effect *but* sbuild is using it (see LP: #1255806)
 169       // once sbuild is fixed, this option can be removed
 170       addArg('f', "fix-broken", "APT::Get::Fix-Broken", 0);
 171    }
 172    else if (CmdMatches("indextargets"))
 173    {
 174       addArg(0,"format","APT::Get::IndexTargets::Format", CommandLine::HasArg);
 175       addArg(0,"release-info","APT::Get::IndexTargets::ReleaseInfo", 0);
 176    }
 177    else if (CmdMatches("clean", "autoclean", "auto-clean", "check", "download", "changelog") ||
 178             CmdMatches("markauto", "unmarkauto")) // deprecated commands
 179       ;
 180    else if (CmdMatches("moo"))
 181       addArg(0, "color", "APT::Moo::Color", 0);
 182
 183    if (CmdMatches("install", "remove", "purge", "upgrade", "dist-upgrade",
 184             "dselect-upgrade", "autoremove", "auto-remove", "clean", "autoclean", "auto-clean", "check",
 185             "build-dep", "full-upgrade", "source"))
 186    {
 187       addArg('s', "simulate", "APT::Get::Simulate", 0);
 188       addArg('s', "just-print", "APT::Get::Simulate", 0);
 189       addArg('s', "recon", "APT::Get::Simulate", 0);
 190       addArg('s', "dry-run", "APT::Get::Simulate", 0);
 191       addArg('s', "no-act", "APT::Get::Simulate", 0);
 192    }
 193
 194    bool const found_something = Args.empty() == false;
 195
 196    // FIXME: move to the correct command(s)
 197    addArg('d',"download-only","APT::Get::Download-Only",0);
 198    addArg('y',"yes","APT::Get::Assume-Yes",0);
 199    addArg('y',"assume-yes","APT::Get::Assume-Yes",0);
 200    addArg(0,"assume-no","APT::Get::Assume-No",0);
 201    addArg('u',"show-upgraded","APT::Get::Show-Upgraded",0);
 202    addArg('m',"ignore-missing","APT::Get::Fix-Missing",0);
 203    addArg('t',"target-release","APT::Default-Release",CommandLine::HasArg);
 204    addArg('t',"default-release","APT::Default-Release",CommandLine::HasArg);
 205    addArg(0,"download","APT::Get::Download",0);
 206    addArg(0,"fix-missing","APT::Get::Fix-Missing",0);
 207    addArg(0,"ignore-hold","APT::Ignore-Hold",0);
 208    addArg(0,"upgrade","APT::Get::upgrade",0);
 209    addArg(0,"only-upgrade","APT::Get::Only-Upgrade",0);
 210    addArg(0,"allow-change-held-packages","APT::Get::allow-change-held-packages",CommandLine::Boolean);
 211    addArg(0,"allow-remove-essential","APT::Get::allow-remove-essential",CommandLine::Boolean);
 212    addArg(0,"allow-downgrades","APT::Get::allow-downgrades",CommandLine::Boolean);
 213    addArg(0,"force-yes","APT::Get::force-yes",0);
 214    addArg(0,"print-uris","APT::Get::Print-URIs",0);
 215    addArg(0,"trivial-only","APT::Get::Trivial-Only",0);
 216    addArg(0,"remove","APT::Get::Remove",0);
 217    addArg(0,"only-source","APT::Get::Only-Source",0);
 218    addArg(0,"arch-only","APT::Get::Arch-Only",0);
 219    addArg(0,"allow-unauthenticated","APT::Get::AllowUnauthenticated",0);
 220    addArg(0,"allow-insecure-repositories","Acquire::AllowInsecureRepositories",0);
 221    addArg(0,"install-recommends","APT::Install-Recommends",CommandLine::Boolean);
 222    addArg(0,"install-suggests","APT::Install-Suggests",CommandLine::Boolean);
 223    addArg(0,"fix-policy","APT::Get::Fix-Policy-Broken",0);
 224
 225    return found_something;
 226 }
 227                                                                         /*}}}*/
 228 static bool addArgumentsAPTMark(std::vector<CommandLine::Args> &Args, char const * const Cmd)/*{{{*/
 229 {
 230    if (CmdMatches("auto", "manual", "hold", "unhold", "showauto",
 231             "showmanual", "showhold", "showholds",
 232             "markauto", "unmarkauto"))
 233    {
 234       addArg('f',"file","Dir::State::extended_states",CommandLine::HasArg);
 235    }
 236    else if (CmdMatches("install", "remove", "deinstall", "purge",
 237             "showinstall", "showinstalls", "showremove", "showremoves",
 238             "showdeinstall", "showdeinstalls", "showpurge", "showpurges"))
 239       ;
 240    else
 241       return false;
 242
 243    if (CmdMatches("markauto", "unmarkauto"))
 244    {
 245       addArg('v',"verbose","APT::MarkAuto::Verbose",0);
 246    }
 247
 248    if (strncmp(Cmd, "show", strlen("show")) != 0)
 249    {
 250       addArg('s',"simulate","APT::Mark::Simulate",0);
 251       addArg('s',"just-print","APT::Mark::Simulate",0);
 252       addArg('s',"recon","APT::Mark::Simulate",0);
 253       addArg('s',"dry-run","APT::Mark::Simulate",0);
 254       addArg('s',"no-act","APT::Mark::Simulate",0);
 255    }
 256
 257    return true;
 258 }
 259                                                                         /*}}}*/
 260 static bool addArgumentsAPT(std::vector<CommandLine::Args> &Args, char const * const Cmd)/*{{{*/
 261 {
 262    if (CmdMatches("list"))
 263    {
 264       addArg('i',"installed","APT::Cmd::Installed",0);
 265       addArg(0,"upgradeable","APT::Cmd::Upgradable",0);
 266       addArg('u',"upgradable","APT::Cmd::Upgradable",0);
 267       addArg(0,"manual-installed","APT::Cmd::Manual-Installed",0);
 268       addArg('v', "verbose", "APT::Cmd::List-Include-Summary", 0);
 269       addArg('a', "all-versions", "APT::Cmd::All-Versions", 0);
 270    }
 271    else if (CmdMatches("show"))
 272    {
 273       addArg('a', "all-versions", "APT::Cache::AllVersions", 0);
 274    }
 275    else if (addArgumentsAPTGet(Args, Cmd) || addArgumentsAPTCache(Args, Cmd))
 276    {
 277        // we have no (supported) command-name overlaps so far, so we call
 278        // specifics in order until we find one which adds arguments
 279    }
 280    else
 281       return false;
 282
 283    return true;
 284 }
 285                                                                         /*}}}*/
 286 std::vector<CommandLine::Args> getCommandArgs(char const * const Program, char const * const Cmd)/*{{{*/
 287 {
 288    std::vector<CommandLine::Args> Args;
 289    Args.reserve(50);
 290    if (Program == NULL || Cmd == NULL)
 291       ; // FIXME: Invalid command supplied
 292    else if (strcmp(Cmd, "help") == 0)
 293       ; // no options for help so no need to implement it in each
 294    else if (strcmp(Program, "apt-get") == 0)
 295       addArgumentsAPTGet(Args, Cmd);
 296    else if (strcmp(Program, "apt-cache") == 0)
 297       addArgumentsAPTCache(Args, Cmd);
 298    else if (strcmp(Program, "apt-cdrom") == 0)
 299       addArgumentsAPTCDROM(Args, Cmd);
 300    else if (strcmp(Program, "apt-config") == 0)
 301       addArgumentsAPTConfig(Args, Cmd);
 302    else if (strcmp(Program, "apt-mark") == 0)
 303       addArgumentsAPTMark(Args, Cmd);
 304    else if (strcmp(Program, "apt") == 0)
 305       addArgumentsAPT(Args, Cmd);
 306
 307    // options without a command
 308    addArg('h', "help", "help", 0);
 309    addArg('v', "version", "version", 0);
 310    // general options
 311    addArg('q', "quiet", "quiet", CommandLine::IntLevel);
 312    addArg('q', "silent", "quiet", CommandLine::IntLevel);
 313    addArg('c', "config-file", 0, CommandLine::ConfigFile);
 314    addArg('o', "option", 0, CommandLine::ArbItem);
 315    addArg(0, NULL, NULL, 0);
 316
 317    return Args;
 318 }
 319                                                                         /*}}}*/
 320 #undef CmdMatches
 321 #undef addArg
 322 static void BinarySpecificConfiguration(char const * const Binary)      /*{{{*/
 323 {
 324    std::string const binary = flNotDir(Binary);
 325    if (binary == "apt" || binary == "apt-config")
 326    {
 327       _config->CndSet("Binary::apt::APT::Color", true);
 328       _config->CndSet("Binary::apt::APT::Cache::Show::Version", 2);
 329       _config->CndSet("Binary::apt::APT::Cache::AllVersions", false);
 330       _config->CndSet("Binary::apt::APT::Cache::ShowVirtuals", true);
 331       _config->CndSet("Binary::apt::APT::Cache::Search::Version", 2);
 332       _config->CndSet("Binary::apt::APT::Get::Upgrade-Allow-New", true);
 333       _config->CndSet("Binary::apt::APT::Cmd::Show-Update-Stats", true);
 334       _config->CndSet("Binary::apt::DPkg::Progress-Fancy", true);
 335       _config->CndSet("Binary::apt::Acquire::AllowInsecureRepositories", false);
 336    }
 337
 338    _config->Set("Binary", binary);
 339    std::string const conf = "Binary::" + binary;
 340    _config->MoveSubTree(conf.c_str(), NULL);
 341 }
 342                                                                         /*}}}*/
 343 void ParseCommandLine(CommandLine &CmdL, CommandLine::DispatchWithHelp const * Cmds, CommandLine::Args * const Args,/*{{{*/
 344       Configuration * const * const Cnf, pkgSystem ** const Sys, int const argc, const char *argv[], bool(*ShowHelp)(CommandLine &, CommandLine::DispatchWithHelp const *))
 345 {
 346    CmdL = CommandLine(Args,_config);
 347    if (Cnf != NULL && pkgInitConfig(**Cnf) == false)
 348    {
 349       _error->DumpErrors();
 350       exit(100);
 351    }
 352
 353    if (likely(argc != 0 && argv[0] != NULL))
 354       BinarySpecificConfiguration(argv[0]);
 355
 356    if (CmdL.Parse(argc,argv) == false ||
 357        (Sys != NULL && pkgInitSystem(*_config, *Sys) == false))
 358    {
 359       if (_config->FindB("version") == true)
 360          ShowHelp(CmdL, Cmds);
 361
 362       _error->DumpErrors();
 363       exit(100);
 364    }
 365
 366    // See if the help should be shown
 367    if (_config->FindB("help") == true || _config->FindB("version") == true ||
 368          (CmdL.FileSize() > 0 && strcmp(CmdL.FileList[0], "help") == 0))
 369    {
 370       ShowHelp(CmdL, Cmds);
 371       exit(0);
 372    }
 373    if (Cmds != nullptr && CmdL.FileSize() == 0)
 374    {
 375       ShowHelp(CmdL, Cmds);
 376       exit(1);
 377    }
 378 }
 379                                                                         /*}}}*/