AbstractCommand.cpp

   1 /*
   2  * This file is part of the vng project
   3  * Copyright (C) 2008 Thomas Zander <tzander@trolltech.com>
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include "AbstractCommand.h"
  20 #include "CommandLineParser.h"
  21 #include "Logger.h"
  22
  23 #include <QDebug>
  24
  25 static const CommandLineOption options[] = {
  26     {"-v, --verbose", "give verbose output"},
  27     {"-q, --quiet", "suppress informational output"},
  28     {"--debug", "print debugging information"},
  29     {"--standard-verbosity", "neither verbose nor quiet output"},
  30     {"--repodir DIRECTORY", "specify the repository directory in which to run"},
  31     {"--dry-run", "don't actually take the action"},
  32     {"--disable", "disable this command"},
  33     {"-h, --help", "shows brief description of command and its arguments"},
  34     {"--use-pager", "use a pager to show the output screen by screen"},
  35     {"--no-pager", "don't use the pager when showing the output"},
  36     CommandLineLastOption
  37 };
  38
  39 AbstractCommand::AbstractCommand(const QString &name)
  40     : m_config(name), m_dryRun(false), m_name(name)
  41 {
  42     CommandLineParser::addOptionDefinitions(options);
  43 }
  44
  45 AbstractCommand::~AbstractCommand()
  46 {
  47 }
  48
  49 AbstractCommand::ReturnCodes AbstractCommand::start()
  50 {
  51     CommandLineParser *args = CommandLineParser::instance();
  52
  53     if (m_config.contains("quiet"))
  54         Logger::setVerbosity(Logger::Quiet);
  55     else if (m_config.contains("verbose"))
  56         Logger::setVerbosity(Logger::Verbose);
  57     else if (m_config.contains("standard-verbosity"))
  58         Logger::setVerbosity(Logger::Chatty);
  59     else if (m_config.contains("debug"))
  60         Logger::setVerbosity(Logger::Debug);
  61
  62     if (args->contains("quiet"))
  63         Logger::setVerbosity(Logger::Quiet);
  64     else if (args->contains("verbose"))
  65         Logger::setVerbosity(Logger::Verbose);
  66     else if (args->contains("standard-verbosity"))
  67         Logger::setVerbosity(Logger::Chatty);
  68     else if (args->contains("debug"))
  69         Logger::setVerbosity(Logger::Debug);
  70
  71     if (args->contains("disable")) {
  72         Logger::warn() << "vng failed: Command `" << m_name << "' disabled with --disable option!" << endl;
  73         return Disabled;
  74     }
  75     if (m_config.contains("disable")) {
  76         Logger::warn() << "vng failed: Command `" << m_name << "' disabled by configuration!" << endl;
  77         return Disabled;
  78     }
  79
  80     if (args->undefinedOptions().count()) {
  81         Logger::error() << "vng failed:  ";
  82         foreach(QString option, args->undefinedOptions()) {
  83             Logger::error() << "unrecognized option `" << option << "'" << endl;
  84         }
  85         return InvalidOptions;
  86     }
  87
  88     if (args->contains("help")) {
  89         args->usage(name(), argumentDescription());
  90         QString command = commandDescription();
  91         if (!command.isEmpty()) {
  92             Logger::standardOut() << endl;
  93             Logger::standardOut() << command;
  94         }
  95         return Ok;
  96     }
  97
  98     if (args->parseErrors().count()) {
  99         Logger::error() << "vng failed:  ";
 100         foreach(QString e, args->parseErrors()) {
 101             Logger::error() << e << endl;
 102         }
 103         return InvalidOptions;
 104     }
 105
 106     m_dryRun = args->contains("dry-run") || m_config.contains("dry-run");
 107
 108     if (args->contains("repodir")) {
 109         m_repository = QDir(args->optionArgument("repodir"));
 110         QDir test = m_repository;
 111         if (! test.cd(".git")) {
 112             Logger::error() << "repository dir `" << args->optionArgument("repodir") << "' is not a repository" << endl;
 113             return InvalidOptions;
 114         }
 115     }
 116     else
 117         m_repository = m_config.repository();
 118     return run();
 119 }
 120
 121 QDir AbstractCommand::repository() const
 122 {
 123     return m_repository;
 124 }
 125
 126 bool AbstractCommand::dryRun() const
 127 {
 128     return m_dryRun;
 129 }
 130
 131 QString AbstractCommand::name() const
 132 {
 133     return m_name;
 134 }
 135
 136 QStringList AbstractCommand::rebasedArguments() const
 137 {
 138     return m_rebasedArguments;
 139 }
 140
 141 bool AbstractCommand::checkInRepository() const
 142 {
 143     if (! QDir(m_repository.absolutePath() + "/.git").exists()) {
 144         Logger::error() << "vng failed:  Unable to `" << m_name << "' here\n\n";
 145         Logger::error() << "You need to be in a repository directory to run this command.\n";
 146         return false;
 147     }
 148     return true;
 149 }
 150
 151 bool AbstractCommand::shouldUsePager() const
 152 {
 153     CommandLineParser *args = CommandLineParser::instance();
 154     return m_config.contains("use-pager") && !args->contains("no-pager") || args->contains("use-pager");
 155 }
 156
 157 void AbstractCommand::moveToRoot()
 158 {
 159     QString currentDir = QDir::current().absolutePath();
 160     QString repoDir = m_repository.absolutePath();
 161     QDir::setCurrent(repoDir);
 162     if (! m_rebasedArguments.isEmpty())
 163         return;
 164     CommandLineParser *args = CommandLineParser::instance();
 165     if (currentDir != repoDir && currentDir.startsWith(repoDir)) {
 166         QString diff = currentDir.mid(repoDir.length() + 1);
 167         // calcuate rebased paths.
 168         bool first = true;
 169         foreach (QString arg, args->arguments()) {
 170             if (first) {
 171                 first = false;
 172                 continue; // first is the command name
 173             }
 174             if (arg == ".") // work around git bug that 'dir/.' doesn't work while 'dir' does work
 175                 m_rebasedArguments << diff;
 176             else if (arg.startsWith('/')) //absolute path
 177                 m_rebasedArguments << arg;
 178             else
 179                 m_rebasedArguments << diff +'/'+ arg;
 180         }
 181     }
 182     else
 183         m_rebasedArguments = args->arguments().mid(1);
 184
 185     if (m_config.useEditMode() && m_config.section() != "edit" && m_config.section() != "add") { // ignore all arguments that we are not editing (except when we start editing ;)
 186         QStringList rebasedArguments = m_rebasedArguments;
 187         m_rebasedArguments.clear();
 188
 189         QStringList editedFiles;
 190         foreach(QByteArray ba, m_config.editedFiles())
 191             editedFiles << QString::fromLocal8Bit(ba.constData());
 192
 193         if (rebasedArguments.isEmpty()) {
 194             m_rebasedArguments = editedFiles;
 195         } else {
 196             foreach (QString rebasedArg, rebasedArguments) {
 197                 bool found = false;
 198                 foreach(QString file, editedFiles) {
 199                     if (file == rebasedArg) {
 200                         found = true;
 201                         break;
 202                     }
 203                 }
 204                 if (!found)
 205                     continue; // ignore file
 206                 m_rebasedArguments << rebasedArg;
 207             }
 208         }
 209     }
 210 }