source: trunk/bin/Parameter.cc @ 629

// $Id: Parameter.cc 629 2008-04-24 14:07:40Z peter $

/*
  Copyright (C) 2006, 2007 Jari Häkkinen, Peter Johansson
  Copyright (C) 2008 Peter Johansson

  This file is part of svndigest, http://trac.thep.lu.se/svndigest

  svndigest is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  svndigest 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, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "Parameter.h"

#include "ColumnStream.h"
#include "subversion_info.h"
#include "utility.h"
#include <config.h> // this header file is created by configure

#include <cstddef>
#include <fstream>
#include <iostream>
#include <sstream>
#include <stdexcept>
#include <string>
#include <sys/stat.h>

namespace theplu {
namespace svndigest {

  Parameter::Parameter( int argc, char *argv[])
    : config_file_(""), copyright_(false), force_(false), 
      generate_config_(false), ignore_cache_(false), report_(true),
      revisions_(false), root_("."), targetdir_("."), verbose_(false)
  {
    for (int i=1; i<argc; ++i) {
      std::stringstream ss(argv[i]);
      std::string myargv("");
      std::string value("");
      getline(ss, myargv, '=');
      getline(ss, value);

      if (myargv=="--config-file"){
        if (value.size()) {
          config_file_.value()= value;
        }
        else if (++i<argc){
          config_file_.value()= std::string(argv[i]);
        }
        else {
          missing_argument(myargv);
        }
      }
      else if (myargv=="--copyright"){
          copyright_.value()=true;
      }
      else if (myargv=="-f" || myargv=="--force"){
          force_.value()=true;
      }
      else if (myargv=="-g" || myargv=="--generate-config"){
          generate_config_.value()=true;
      }
      else if (myargv=="-h" || myargv=="--help"){
        help();
        exit(0);      // always exit after printing help
      }
      else if (myargv=="--ignore-cache"){
          ignore_cache_.value()=true;
      }
      else if (myargv=="-r" || myargv=="--root"){
        if (value.size()) {
          root_.value()= value;
        }
        else if (++i<argc){
          root_.value()= std::string(argv[i]);
        }
        else {
          missing_argument(myargv);
        }
      }
      else if (myargv=="--report") {
          report_.value()=true;
      }
      else if (myargv=="--no-report") {
          report_.value()=false;
      }
      else if (myargv=="--revisions") {
          revisions_.value()=true;
      }
      else if (myargv=="-t" || myargv=="--target"){
        if (value.size()) {
          targetdir_.value()= value;
        }
        else if (++i<argc){
          targetdir_.value()= std::string(argv[i]);
        }
        else {
          missing_argument(myargv);
        }
      }
      else if (myargv=="-v" || myargv=="--verbose"){
          verbose_.value()=true;
      }
      else if (myargv=="--version"){
        version();
        exit(0);
      }
      else if (myargv=="-vf" || myargv=="-fv"){
          verbose_.value()=true;
          force_.value()=true;
      }
      else {
        throw std::runtime_error("svndigest: invalid option: " + myargv +
                                 "\nTry `svndigest --help' for usage.");
      } 
  }

    analyse();
  }


  void Parameter::analyse(void)
  {
    using namespace std;

    string workdir(pwd()); // remember current working directory (cwd).

    bool root_ok = ( node_exist(root_.value()) && 
                     !access_rights(root_.value(), "r") );
    
    if (root_ok) {
      // Check that root_ is a directory
      struct stat nodestat;
      stat(root_.value().c_str(), &nodestat);
      if (!S_ISDIR(nodestat.st_mode))
        throw runtime_error(string("svndigest: accessing `") + root_.value() +
                            "': Not a directory.");
    }

    // Checking that root_ exists and retrieve the absolute path to root_
    if (!root_ok || chdir(root_.value().c_str()))
      throw runtime_error(string("svndigest: Root directory (") + root_.value() +
                          ") access failed.");
    root_.value() = pwd();

      

    // need to get back to cwd if relative paths are used.
    if (chdir(workdir.c_str()))
      runtime_error(string("svndigest: Failed to access cwd: ") + workdir);

    // Checking that targetdir_ exists and retrieve the absolute path
    // to targetdir_
    if (chdir(targetdir_.value().c_str()))
      throw runtime_error(string("svndigest: Target directory (") + 
                          targetdir_.value() + ") access failed.");
    targetdir_.value() = pwd();
    // Checking write permissions for targetdir_
    if (access_rights(targetdir_.value(),"w"))
      throw runtime_error(string("svndigest: No write permission on target ") +
                                 "directory (" + targetdir_.value() +").");

    // return back to cwd
    if (chdir(workdir.c_str()))
      throw runtime_error(string("svndigest: Failed to access cwd: ") + workdir);

  }


  std::string Parameter::config_file(void) const
  {
    // not default
    if (!config_file_.value().empty())
      return config_file_.value();
    
    // default behaviour
    return root()+"/.svndigest/config";
  }


  void Parameter::help(void) const
  {
    ColumnStream cs(std::cout, 1);
    cs.width(0)=79;
    cs.margin(0)=0;
    ColumnStream cs2(std::cout, 2);
    // Widest line should fit exactly
    cs2.width(0)=21;
    cs2.width(1)=52;
    cs2.margin(0)=2;
    // Gnits standard suggest three characters gap between option and description
    cs2.margin(1)=3;

    std::cout << "Usage: svndigest [OPTION]...\n"
              << "\n";

    cs << "Generate statistical report for a subversion repository.\n";

    cs << "\nMandatory arguments to long options are mandatory for "
       << "short options too.\n";

    cs2  << "    --config-file=ARG\tconfiguration file " 
         << "[<ROOT>/.svndigest/config]\n"
         << "    --copyright\tupdate copyright statement\n" 
         << "-f, --force\tif sub-directory named <ROOT> exists in "
         << "target directory, remove sub-directory before writing results\n"
         << "-g, --generate-config\twrite configuration file " 
         << "to standard output and exit\n"
         << "-h, --help\tdisplay this help and exit\n"
         << "    --ignore-cache\tIgnore cache files and analyze "
         << "everything from repository\n"
         << "    --no-report\tCreate no HTML report\n"
         << "    --revisions\tUse revision numbers as time scale "
         << "instead of dates [dates]\n"
         << "-r, --root=ROOT\tsvn controlled directory to perform "
         << "statistics calculation on [" << root_.default_value() << "]\n"
         << "-t, --target=TARGET\toutput directory [" 
         << targetdir_.default_value() << "]\n"
         << "-v, --verbose\texplain what is being done\n"
         << "    --version\tprint version information and exit\n";

    std::cout << "\nReport bugs to <" << PACKAGE_BUGREPORT << ">." 
              << std::endl;
  }


  void Parameter::missing_argument(std::string opt) const
  {
    if (opt.size()>0 && opt[0]=='-')
      opt = opt.substr(1);
    if (opt.size()>0 && opt[0]=='-')
      opt = opt.substr(1);
    std::stringstream ss;
    ss << "svndigest: option requires an argument -- " << opt << "\n"
       << "Try `svndigest --help' for usage."; 
    throw std::runtime_error(ss.str());
  }

  void Parameter::version(bool verbose) const
  {
    ColumnStream cs(std::cout, 1);
    cs.width(0)=79;
    cs << PACKAGE_STRING << version_string() << "\n";
    cs << "\nCopyright (C) " << svn_year() 
       << " Jari H\u00E4kkinen and Peter Johansson.\n"
       << "This is free software. You may redistribute copies of it under "
       << "the terms of the GNU General Public License "
       << "<http://www.gnu.org/licenses/gpl.html>.\n"
       << "There is NO WARRANTY; to the extent permitted by law.\n";
  }

}} // of namespace svndigest and namespace theplu