deskflow/src/lib/synergy/ArgParser.cpp

/*
 * synergy -- mouse and keyboard sharing utility
 * Copyright (C) 2014-2016 Symless Ltd.
 *
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file LICENSE that should have accompanied this file.
 *
 * This package 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, see <http://www.gnu.org/licenses/>.
 */

#include "synergy/ArgParser.h"

#include "base/Log.h"
#include "base/String.h"
#include "synergy/App.h"
#include "synergy/ArgsBase.h"
#include "synergy/ClientArgs.h"
#include "synergy/ServerArgs.h"
#include "synergy/StreamChunker.h"
#include "synergy/ToolArgs.h"

#ifdef WINAPI_MSWINDOWS
#include <VersionHelpers.h>
#endif

lib::synergy::ArgsBase *ArgParser::m_argsBase = NULL;

ArgParser::ArgParser(App *app) : m_app(app) {}

bool ArgParser::parseServerArgs(lib::synergy::ServerArgs &args, int argc,
                                const char *const *argv) {
  setArgsBase(args);
  updateCommonArgs(argv);
  int i = 1;
  while (i < argc) {
    if (parsePlatformArg(args, argc, argv, i)) {
      ++i;
      continue;
    } else if (parseGenericArgs(argc, argv, i)) {
      ++i;
      continue;
    } else if (parseDeprecatedArgs(argc, argv, i)) {
      ++i;
      continue;
    } else if (isArg(i, argc, argv, "-c", "--config", 1)) {
      // save configuration file path
      args.m_configFile = argv[++i];
    } else if (isArg(i, argc, argv, "", "--serial-key", 1)) {
      args.m_serial = SerialKey(argv[++i]);
    } else if (isArg(i, argc, argv, nullptr, "server")) {
      ++i;
      continue;
    } else {
      LOG((CLOG_CRIT "%s: unrecognized option `%s'" BYE, args.m_pname, argv[i],
           args.m_pname));
      return false;
    }
    ++i;
  }

  if (checkUnexpectedArgs()) {
    return false;
  }

  return true;
}

bool ArgParser::parseClientArgs(lib::synergy::ClientArgs &args, int argc,
                                const char *const *argv) {
  setArgsBase(args);
  updateCommonArgs(argv);

  int i{1};
  while (i < argc) {
    if (parsePlatformArg(args, argc, argv, i)) {
      ++i;
      continue;
    } else if (parseGenericArgs(argc, argv, i)) {
      ++i;
      continue;
    } else if (parseDeprecatedArgs(argc, argv, i)) {
      ++i;
      continue;
    } else if (isArg(i, argc, argv, nullptr, "--camp")) {
      // ignore -- included for backwards compatibility
    } else if (isArg(i, argc, argv, nullptr, "--no-camp")) {
      // ignore -- included for backwards compatibility
    } else if (isArg(i, argc, argv, nullptr, "--yscroll", 1)) {
      // define scroll
      args.m_yscroll = atoi(argv[++i]);
    } else if (isArg(i, argc, argv, nullptr, "--sync-language")) {
      args.m_enableLangSync = true;
    } else if (isArg(i, argc, argv, nullptr, "--invert-scroll")) {
      args.m_clientScrollDirection =
          lib::synergy::ClientScrollDirection::INVERT_SERVER;
    } else if (isArg(i, argc, argv, nullptr, "--host")) {
      args.m_hostMode = true;
    } else if (isArg(i, argc, argv, nullptr, "client")) {
      ++i;
      continue;
    } else {
      if (i + 1 == argc) {
        args.m_serverAddress = argv[i];
        return true;
      }

      LOG((CLOG_CRIT "%s: unrecognized option `%s'" BYE, args.m_pname, argv[i],
           args.m_pname));
      return false;
    }
    ++i;
  }

  // exactly one non-option argument (server-address)
  if (i == argc && !args.m_shouldExitFail && !args.m_shouldExitOk) {
    LOG((CLOG_CRIT "%s: a server address or name is required" BYE, args.m_pname,
         args.m_pname));
    return false;
  }

  if (checkUnexpectedArgs()) {
    return false;
  }

  return true;
}

bool ArgParser::parsePlatformArg(lib::synergy::ArgsBase &argsBase,
                                 const int &argc, const char *const *argv,
                                 int &i) {
#if WINAPI_MSWINDOWS
  if (isArg(i, argc, argv, nullptr, "--service")) {
    LOG((CLOG_WARN "obsolete argument --service, use synergyd instead."));
    argsBase.m_shouldExitFail = true;
  } else if (isArg(i, argc, argv, nullptr, "--exit-pause")) {
    argsBase.m_pauseOnExit = true;
  } else if (isArg(i, argc, argv, nullptr, "--stop-on-desk-switch")) {
    argsBase.m_stopOnDeskSwitch = true;
  } else {
    // option not supported here
    return false;
  }

  return true;
#elif WINAPI_XWINDOWS
  if (isArg(i, argc, argv, "-display", "--display", 1)) {
    // use alternative display
    argsBase.m_display = argv[++i];
  }

  else if (isArg(i, argc, argv, nullptr, "--no-xinitthreads")) {
    argsBase.m_disableXInitThreads = true;
  }

  else {
    // option not supported here
    return false;
  }

  return true;
#elif WINAPI_CARBON
  // no options for carbon
  return false;
#endif
}

bool ArgParser::parseToolArgs(ToolArgs &args, int argc,
                              const char *const *argv) {
  // We support exactly one argument at a fix position
  static const int only_index{1};
  if (isArg(only_index, argc, argv, nullptr, "--get-active-desktop", 0)) {
    args.m_printActiveDesktopName = true;
    return true;
  } else if (isArg(only_index, argc, argv, nullptr, "--get-installed-dir", 0)) {
    args.m_getInstalledDir = true;
    return true;
  } else if (isArg(only_index, argc, argv, nullptr, "--get-profile-dir", 0)) {
    args.m_getProfileDir = true;
    return true;
  } else if (isArg(only_index, argc, argv, nullptr, "--get-arch", 0)) {
    args.m_getArch = true;
    return true;
  }
  return false;
}

bool ArgParser::parseGenericArgs(int argc, const char *const *argv, int &i) {
  if (isArg(i, argc, argv, "-a", "--address", 1)) {
    argsBase().m_synergyAddress = argv[++i];
  } else if (isArg(i, argc, argv, "-d", "--debug", 1)) {
    // change logging level
    argsBase().m_logFilter = argv[++i];
  } else if (isArg(i, argc, argv, "-l", "--log", 1)) {
    argsBase().m_logFile = argv[++i];
  } else if (isArg(i, argc, argv, "-f", "--no-daemon")) {
    // not a daemon
    argsBase().m_daemon = false;
  } else if (isArg(i, argc, argv, nullptr, "--daemon")) {
    // daemonize
    argsBase().m_daemon = true;
  } else if (isArg(i, argc, argv, "-n", "--name", 1)) {
    // save screen name
    argsBase().m_name = argv[++i];
  } else if (isArg(i, argc, argv, "-1", "--no-restart")) {
    // don't try to restart
    argsBase().m_restartable = false;
  } else if (isArg(i, argc, argv, nullptr, "--restart")) {
    // try to restart
    argsBase().m_restartable = true;
  } else if (isArg(i, argc, argv, nullptr, "--no-hooks")) {
    argsBase().m_noHooks = true;
  } else if (isArg(i, argc, argv, "-h", "--help")) {
    if (m_app) {
      m_app->help();
    }
    argsBase().m_shouldExitOk = true;
  } else if (isArg(i, argc, argv, nullptr, "--version")) {
    if (m_app) {
      m_app->version();
    }
    argsBase().m_shouldExitOk = true;
  } else if (isArg(i, argc, argv, nullptr, "--no-tray")) {
    argsBase().m_disableTray = true;
  } else if (isArg(i, argc, argv, nullptr, "--ipc")) {
    argsBase().m_enableIpc = true;
  } else if (isArg(i, argc, argv, nullptr, "--server")) {
    // HACK: stop error happening when using portable (synergyp)
  } else if (isArg(i, argc, argv, nullptr, "--client")) {
    // HACK: stop error happening when using portable (synergyp)
  } else if (isArg(i, argc, argv, nullptr, "--enable-drag-drop")) {
    bool useDragDrop = true;

#ifdef WINAPI_XWINDOWS

    useDragDrop = false;
    LOG((CLOG_INFO "ignoring --enable-drag-drop, not supported on linux."));

#endif

#ifdef WINAPI_MSWINDOWS

    if (!IsWindowsVistaOrGreater()) {
      useDragDrop = false;
      LOG((CLOG_INFO
           "ignoring --enable-drag-drop, not supported below vista."));
    }
#endif

    if (useDragDrop) {
      argsBase().m_enableDragDrop = true;
    }
  } else if (isArg(i, argc, argv, nullptr, "--enable-crypto")) {
    argsBase().m_enableCrypto = true;
  } else if (isArg(i, argc, argv, nullptr, "--profile-dir", 1)) {
    argsBase().m_profileDirectory = argv[++i];
  } else if (isArg(i, argc, argv, nullptr, "--plugin-dir", 1)) {
    argsBase().m_pluginDirectory = argv[++i];
  } else if (isArg(i, argc, argv, nullptr, "--tls-cert", 1)) {
    argsBase().m_tlsCertFile = argv[++i];
  } else if (isArg(i, argc, argv, nullptr, "--prevent-sleep")) {
    argsBase().m_preventSleep = true;
  } else {
    // option not supported here
    return false;
  }

  return true;
}

bool ArgParser::parseDeprecatedArgs(int argc, const char *const *argv, int &i) {
  static const std::vector<const char *> deprecatedArgs = {
      "--crypto-pass", "--res-w", "--res-h", "--prm-wc", "--prm-hc"};

  for (auto &arg : deprecatedArgs) {
    if (isArg(i, argc, argv, nullptr, arg)) {
      LOG((CLOG_NOTE "%s is deprecated", arg));
      i++;
      return true;
    }
  }

  return false;
}

bool ArgParser::isArg(int argi, int argc, const char *const *argv,
                      const char *name1, const char *name2,
                      int minRequiredParameters) {
  if ((name1 != nullptr && strcmp(argv[argi], name1) == 0) ||
      (name2 != nullptr && strcmp(argv[argi], name2) == 0)) {
    // match.  check args left.
    if (argi + minRequiredParameters >= argc) {
      LOG((CLOG_PRINT "%s: missing arguments for `%s'" BYE, argsBase().m_pname,
           argv[argi], argsBase().m_pname));
      argsBase().m_shouldExitFail = true;
      return false;
    }
    return true;
  }

  // no match
  return false;
}

void ArgParser::splitCommandString(String &command, std::vector<String> &argv) {
  if (command.empty()) {
    return;
  }

  size_t leftDoubleQuote = 0;
  size_t rightDoubleQuote = 0;
  searchDoubleQuotes(command, leftDoubleQuote, rightDoubleQuote);

  size_t startPos = 0;
  size_t space = command.find(" ", startPos);

  while (space != String::npos) {
    bool ignoreThisSpace = false;

    // check if the space is between two double quotes
    if (space > leftDoubleQuote && space < rightDoubleQuote) {
      ignoreThisSpace = true;
    } else if (space > rightDoubleQuote) {
      searchDoubleQuotes(command, leftDoubleQuote, rightDoubleQuote,
                         rightDoubleQuote + 1);
    }

    if (!ignoreThisSpace) {
      String subString = command.substr(startPos, space - startPos);

      removeDoubleQuotes(subString);
      argv.push_back(subString);
    }

    // find next space
    if (ignoreThisSpace) {
      space = command.find(" ", rightDoubleQuote + 1);
    } else {
      startPos = space + 1;
      space = command.find(" ", startPos);
    }
  }

  String subString = command.substr(startPos, command.size());
  removeDoubleQuotes(subString);
  argv.push_back(subString);
}

bool ArgParser::searchDoubleQuotes(String &command, size_t &left, size_t &right,
                                   size_t startPos) {
  bool result = false;
  left = String::npos;
  right = String::npos;

  left = command.find("\"", startPos);
  if (left != String::npos) {
    right = command.find("\"", left + 1);
    if (right != String::npos) {
      result = true;
    }
  }

  if (!result) {
    left = 0;
    right = 0;
  }

  return result;
}

void ArgParser::removeDoubleQuotes(String &arg) {
  // if string is surrounded by double quotes, remove them
  if (arg[0] == '\"' && arg[arg.size() - 1] == '\"') {
    arg = arg.substr(1, arg.size() - 2);
  }
}

const char **ArgParser::getArgv(std::vector<String> &argsArray) {
  size_t argc = argsArray.size();

  // caller is responsible for deleting the outer array only
  // we use the c string pointers from argsArray and assign
  // them to the inner array. So caller only need to use
  // delete[] to delete the outer array
  const char **argv = new const char *[argc];

  for (size_t i = 0; i < argc; i++) {
    argv[i] = argsArray[i].c_str();
  }

  return argv;
}

String ArgParser::assembleCommand(std::vector<String> &argsArray,
                                  String ignoreArg, int parametersRequired) {
  String result;

  for (std::vector<String>::iterator it = argsArray.begin();
       it != argsArray.end(); ++it) {
    if (it->compare(ignoreArg) == 0) {
      it = it + parametersRequired;
      continue;
    }

    // if there is a space in this arg, use double quotes surround it
    if ((*it).find(" ") != String::npos) {
      (*it).insert(0, "\"");
      (*it).push_back('\"');
    }

    result.append(*it);
    // add space to saperate args
    result.append(" ");
  }

  if (!result.empty()) {
    // remove the tail space
    result = result.substr(0, result.size() - 1);
  }

  return result;
}

void ArgParser::updateCommonArgs(const char *const *argv) {
  argsBase().m_name = ARCH->getHostName();
  argsBase().m_pname = ARCH->getBasename(argv[0]);
}

bool ArgParser::checkUnexpectedArgs() {
#if SYSAPI_WIN32
  // suggest that user installs as a windows service. when launched as
  // service, process should automatically detect that it should run in
  // daemon mode.
  if (argsBase().m_daemon) {
    LOG((CLOG_ERR "the --daemon argument is not supported on windows. "
                  "instead, install %s as a service (--service install)",
         argsBase().m_pname));
    return true;
  }
#endif

  return false;
}