source: trunk/lib/Configuration.cc @ 1052

Last change on this file since 1052 was 1052, checked in by Peter Johansson, 13 years ago

refs #450. using fnmatch in codon fil name pattern match.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 16.8 KB
Line 
1// $Id: Configuration.cc 1052 2010-04-18 02:39:57Z peter $
2
3/*
4  Copyright (C) 2007, 2008, 2009 Jari Häkkinen, Peter Johansson
5  Copyright (C) 2010 Peter Johansson
6
7  This file is part of svndigest, http://dev.thep.lu.se/svndigest
8
9  svndigest is free software; you can redistribute it and/or modify it
10  under the terms of the GNU General Public License as published by
11  the Free Software Foundation; either version 3 of the License, or
12  (at your option) any later version.
13
14  svndigest is distributed in the hope that it will be useful, but
15  WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  General Public License for more details.
18
19  You should have received a copy of the GNU General Public License
20  along with svndigest. If not, see <http://www.gnu.org/licenses/>.
21*/
22
23#include <config.h>
24
25#include "Configuration.h"
26
27#include "Colors.h"
28#include "Functor.h"
29
30#include <cassert>
31#include <fstream>
32#include <map>
33#include <string>
34#include <sstream>
35#include <stdexcept>
36#include <utility>
37
38namespace theplu{
39namespace svndigest{
40
41  Configuration* Configuration::instance_=NULL;
42
43
44  Configuration::Configuration(void)
45  {
46  }
47
48
49  void Configuration::add_codon(std::string key, std::string start, 
50                                std::string end)
51  {
52    std::pair<std::string, std::string> p(start,end);
53    String2Codons::iterator iter = string2codons_.end();
54    for (String2Codons::iterator i=string2codons_.begin();
55         i!=string2codons_.end(); ++i)
56      if (i->first == key)
57        iter = i;
58   
59    if (iter==string2codons_.end())
60      string2codons_.push_back(std::make_pair(key, VectorPair(1,p)));
61    else
62      iter->second.push_back(p);
63  }
64
65
66  const std::map<std::string, std::string>&
67  Configuration::author_colors(void) const
68  {
69    return author_color_;
70  }
71
72  std::string Configuration::author_str_color(const std::string& author) const
73  {
74    std::string res;
75    std::map<std::string, std::string>::const_iterator iterator;
76    if ( (iterator=author_color_.find(author)) != author_color_.end())
77      res = iterator->second;
78    return res;
79  }
80
81
82  const std::vector<std::pair<std::string, std::string> >* 
83  Configuration::codon(std::string file_name) const 
84  {
85    std::cout << "file_name: " << file_name << std::endl;
86    if (const std::pair<std::string,std::string>* dict=dictionary(file_name))
87      file_name = translate(file_name, *dict);
88    for (String2Codons::const_iterator i(string2codons_.begin());
89         i!=string2codons_.end(); ++i) {
90      if (fnmatch(i->first.c_str(), file_name.c_str()))
91        return &i->second;
92    }
93    return NULL;
94  }
95
96
97  const std::map<std::string,Alias>& Configuration::copyright_alias(void) const
98  {
99    return copyright_alias_;
100  }
101
102
103  const std::pair<std::string,std::string>* 
104  Configuration::dictionary(std::string lhs) const
105  {
106    for (size_t i=0; i<dictionary_.size(); ++i)
107      if (fnmatch(lhs.c_str(), dictionary_[i].first.c_str()))
108        return &dictionary_[i];
109    return NULL;
110  }
111
112
113  bool Configuration::equal_false(const std::string& str) const
114  {
115    return str=="false" || str=="False" || str=="FALSE" ||
116      str=="no" || str=="No" || str=="NO";
117  }
118
119
120  bool Configuration::equal_true(const std::string& str) const
121  {
122    return str=="true" || str=="True" || str=="TRUE" ||
123      str=="yes" || str=="Yes" || str=="YES";
124  }
125
126
127  const std::string& Configuration::image_anchor_format(void) const
128  {
129    return image_anchor_format_;
130  }
131
132
133  const std::string& Configuration::image_format(void) const
134  {
135    return image_format_;
136  }
137
138
139  void Configuration::load(void)
140  {
141    set_default();
142    validate_dictionary();
143  }
144
145
146  void Configuration::load(std::istream& is)
147  {
148    assert(is.good());
149
150    bool parsing_found=false;
151    bool dictionary_found=false;
152    std::string line;
153    std::string section;
154    std::string tmp;
155    while (getline(is, line)) {
156      line = ltrim(line);
157      if (line.empty() || line[0]=='#')
158        continue;
159      std::stringstream ss(line);
160      if (line[0] == '[') {
161        getline(ss, tmp, '[');
162        getline(ss, section, ']');
163        continue;
164      }
165      std::string lhs;
166      getline(ss, lhs, '=');
167      lhs = trim(lhs);
168      std::string rhs;
169      getline(ss, rhs);
170      rhs = trim(rhs);
171      if (rhs.empty()){
172        throw Config_error(line, "expected format: <lhs> = <rhs>");
173      }
174      if (section == "copyright-alias"){
175        std::map<std::string,Alias>::iterator iter = 
176          copyright_alias_.lower_bound(lhs);
177        if (iter!=copyright_alias_.end() && iter->first==lhs){
178          std::stringstream mess;
179          mess << "in copright-alias section " << lhs << " defined twice.";
180          throw Config_error(line, mess.str());
181        }
182       
183        // insert alias
184        copyright_alias_.insert(iter,std::make_pair(lhs, Alias(rhs,copyright_alias_.size())));
185      }
186      else if (section == "trac"){
187        if (lhs=="trac-root")
188          trac_root_=rhs;
189        else {
190          std::stringstream mess;
191          mess << "in trac section" << lhs + " is invalid option.";
192          throw Config_error(line, mess.str());
193        }
194      }
195      else if (section == "copyright") {
196        if (lhs=="missing-copyright-warning") {
197          if (equal_false(rhs))
198            missing_copyright_warning_ = false;
199          else if (equal_true(rhs))
200            missing_copyright_warning_ = true;
201          else {
202            throw Config_error(line, "");
203          }
204        }
205      }
206      else if (section == "author-color") {
207        unsigned char r,g,b;
208        try {
209          str2rgb(rhs, r,g,b);
210        }
211        catch (std::runtime_error& e) {
212          throw Config_error(line, e.what());
213        }
214        author_color_[lhs] = rhs;
215      }     
216      else if (section == "parsing-codons") {
217        if (!parsing_found) {
218          parsing_found=true;
219          // clearing the default setting
220          string2codons_.clear();
221        }
222       
223        if (codon(lhs)) {
224          std::stringstream mess;
225          mess << "clashes with previous given file name pattern: ";
226          // find previous file-name-pattern
227          for (String2Codons::const_iterator i(string2codons_.begin());
228               i!=string2codons_.end(); ++i) {
229            if (fnmatch(lhs.c_str(), i->first.c_str())) {
230              mess << "`" << i->first << "'";
231              break;
232            }
233          }
234          throw Config_error(line, mess.str());
235        }
236        std::stringstream ss(rhs);
237        std::string start;
238        while (getline(ss, start, ':')) {
239          start = trim(start);
240          std::string end;
241          getline(ss, end, ';');
242          end = trim(end);
243          if (start.empty() && end.empty())
244            continue;
245          try {
246            if (start.empty() || start=="\"\"") {
247              throw std::runtime_error("start-code is empty");
248            }
249            else if (start.size()<3) {
250              std::stringstream mess;
251              mess << "start-code `" << start << "' is invalid";
252              throw std::runtime_error(mess.str());
253            }
254            start = trim(start, '"');
255            if (end.empty() || end=="\"\"") {
256              throw std::runtime_error("end-code is empty");
257            }
258            else if (end.size()<3) {
259              std::stringstream mess;
260              mess << "end-code `" << end << "' is invalid";
261              throw std::runtime_error(mess.str());
262            }
263            end = trim(end, '"');
264          }
265          catch (std::runtime_error& e){
266            throw Config_error(line, e.what());
267          }
268          replace(start, "\\n", "\n");
269          replace(end, "\\n", "\n");
270          add_codon(lhs, start, end);
271        }
272      } 
273      else if (section == "file-name-dictionary") {
274        if (!dictionary_found) {
275          dictionary_found=true;
276          // clearing the default setting
277          dictionary_.clear();
278        }
279       
280        if (const std::pair<std::string, std::string>* entry=dictionary(lhs)) {
281          std::stringstream mess;
282          mess << "clashes with previous given file name pattern: "
283               << "`" << entry->first << "'";
284          throw Config_error(line, mess.str());
285        }
286        lhs = trim(lhs);
287        rhs = trim(rhs);
288        if (!lhs.empty() && !rhs.empty()) 
289          dictionary_.push_back(std::make_pair(lhs, rhs));
290        else if (!lhs.empty() || !rhs.empty()) {
291          throw Config_error(line, "");
292        }
293      } 
294      else if (section == "image") {
295        if (lhs == "format") {
296          try {
297            image_format(rhs);
298          }
299          catch (std::runtime_error e) {
300            throw Config_error(line, 
301                               "unknown format: " + rhs + "\n" + e.what());
302          }
303        }
304        else if (lhs == "image_format") {
305          try {
306            image_anchor_format(rhs);
307          }
308          catch (std::runtime_error e) {
309            throw Config_error(line, 
310                               "unknown format: " + rhs + "\n" + e.what());
311          }
312        }
313      }
314    }
315    validate_dictionary();
316  }
317
318
319  void Configuration::image_anchor_format(const std::string& format)
320  {
321    if (format!="none" && format!="pdf" && format!="png" && format!="svg") {
322      std::ostringstream oss;
323      oss << "Valid arguments are:\n"
324          << "  - `none'\n"
325          << "  - `pdf'\n"
326          << "  - `png'\n"
327          << "  - `svg'";
328      throw std::runtime_error(oss.str());
329    }
330    image_anchor_format_ = format;
331  }
332
333
334  void Configuration::image_format(const std::string& format)
335  {
336    if (format!="none" && format!="png" && format!="svg") {
337      std::ostringstream oss;
338      oss << "Valid arguments are:\n"
339          << "  - `none'\n"
340          << "  - `png'\n"
341          << "  - `svg'";
342      throw std::runtime_error(oss.str());
343    }
344    image_format_ = format;
345  }
346
347
348  Configuration& Configuration::instance(void)
349  {
350    if (!instance_){
351      instance_ = new Configuration;
352      instance_->load();
353    }
354    return *instance_;
355  }
356
357
358  bool Configuration::missing_copyright_warning(void) const
359  {
360    return missing_copyright_warning_;
361  }
362
363
364  std::string
365  Configuration::translate(const std::string& str,
366                           const std::pair<std::string, std::string>& dic) const
367  {
368    std::string res;
369    std::vector<std::string> vec;
370    if (!regexp(str.begin(), str.end(), dic.first.begin(),dic.first.end(),vec)){
371      std::stringstream mess;
372      mess << "svndigest: invalid config file: "
373           << "expression " << dic.first << " is invalid";
374      throw std::runtime_error(mess.str());       
375    }
376    for (std::string::const_iterator i(dic.second.begin()); 
377         i!=dic.second.end(); ++i) {
378      if (*i == '$') {
379        std::stringstream ss(std::string(i+1, dic.second.end()));
380        size_t n = 0;
381        ss >> n;
382        if (n>vec.size() || n==0){
383          std::stringstream mess;
384          mess << "svndigest: invalid config file: "
385               << "expression " << dic.second << " is invalid";
386          if (n)
387            mess << "because " << n << " is a too large.";
388          throw std::runtime_error(mess.str());       
389        }
390        res += vec[n-1];
391        ++i;
392        if (n>9){
393          ++i;
394          if (n>99)
395            ++i;
396
397        }
398      }
399      else
400        res += *i;
401    }
402
403    return res;
404  }
405
406
407  std::string trans_end_code(std::string str)
408  {
409    if (str.size()>0 && str[str.size()-1]=='\n')
410      return str.substr(0, str.size()-1) + std::string("\\n");
411    return str;
412  }
413
414
415  std::string trans_beg_code(std::string str)
416  {
417    if (str.size()>0 && str[0]=='\n')
418      return std::string("\\n") + str.substr(1); 
419    return str;
420  }
421
422
423  std::string trim(std::string str, char c)
424  {
425    if (str.size()<2 || str[0]!=c || str[str.size()-1]!=c){
426      std::stringstream mess;
427      mess << "expected `" << str << "' to be surrounded by `" << c << "'";
428      throw std::runtime_error(mess.str());
429    }
430    return str.substr(1, str.size()-2);
431  }
432
433
434  void Configuration::set_default(void)
435  {
436    copyright_alias_.clear();
437    missing_copyright_warning_=false;
438    trac_root_ = "";
439
440    add_codon("*.ac", "#", "\n");
441    add_codon("*.ac", "dnl", "\n");
442    add_codon("*.am", "#", "\n");
443    add_codon("*.as", "#", "\n");
444    add_codon("*.as", "dnl", "\n");
445    add_codon("*.bat", "\nREM", "\n");
446    add_codon("*.bat", "\nrem", "\n");
447    add_codon("*.c", "//", "\n");
448    add_codon("*.c", "/*", "*/");
449    add_codon("*.cc", "//", "\n");
450    add_codon("*.cc", "/*", "*/");
451    add_codon("*.cpp", "//", "\n");
452    add_codon("*.cpp", "/*", "*/");
453    add_codon("*.css", "<!--", "-->");
454    add_codon("*.cxx", "//", "\n");
455    add_codon("*.cxx", "/*", "*/");
456    add_codon("*.h", "//", "\n");
457    add_codon("*.h", "/*", "*/");
458    add_codon("*.hh", "//", "\n");
459    add_codon("*.hh", "/*", "*/");
460    add_codon("*.hpp", "//", "\n");
461    add_codon("*.hpp", "/*", "*/");
462    add_codon("*.html", "<%--", "--%>");
463    add_codon("*.java", "//", "\n");
464    add_codon("*.java", "/*", "*/");
465    add_codon("*.jsp", "<!--", "-->");
466    add_codon("*.m", "%", "\n");
467    add_codon("*.m4", "#", "\n");
468    add_codon("*.m4", "dnl", "\n");
469    add_codon("*.pl", "#", "\n");
470    add_codon("*.pm", "#", "\n");
471    add_codon("*.R", "#", "\n");
472    add_codon("*.rss", "<!--", "-->");
473    add_codon("*.sgml", "<!--", "-->");
474    add_codon("*.sh", "#", "\n");
475    add_codon("*.shtml", "<!--", "-->");
476    add_codon("*.tex", "%", "\n");
477    add_codon("*.xhtml", "<!--", "-->");
478    add_codon("*.xml", "<!--", "-->");
479    add_codon("*.xsd", "<!--", "-->");
480    add_codon("*.xsl", "<!--", "-->");
481    add_codon("*config", "#", "\n");
482    add_codon("bootstrap", "#", "\n");
483    add_codon("Makefile", "#", "\n");
484
485    dictionary_ = VectorPair(1, std::make_pair("*.in", "$1"));
486    image_format_ = "png";
487    image_anchor_format_ = "png";
488  }
489
490
491  std::string Configuration::trac_root(void) const
492  {
493    return trac_root_;
494  }
495
496
497  void Configuration::validate_dictionary(void) const
498  {
499    VectorPair::const_iterator end(dictionary_.end());
500    for (VectorPair::const_iterator iter(dictionary_.begin());iter!=end;++iter){
501      std::string word(iter->first);
502      replace(word, "*", "");
503      replace(word, "?", "");
504      // throws if dictionary is invalid
505      translate(word, *iter);
506    }
507  }
508
509
510  std::ostream& operator<<(std::ostream& os, const Configuration& conf)
511  {
512    os << "### This file configures various behaviors for svndigest\n"
513       << "### The commented-out below are intended to demonstrate how to use\n"
514       << "### this file.\n"
515       << "\n"
516       << "### Section for setting behaviour of copyright update\n"
517       << "[copyright]\n"
518       << "# if true svndigest will warn if file has no copyright statement.\n"
519       << "missing-copyright-warning = ";
520   
521    if (conf.missing_copyright_warning())
522      os << "yes\n";
523    else
524      os << "no\n";
525
526    os << "\n"
527       << "### Section for setting aliases used in copyright update\n"
528       << "[copyright-alias]\n"
529       << "# jdoe = John Doe\n";
530
531    typedef std::vector<std::pair<std::string, Alias> > vector;
532    vector vec;
533    std::back_insert_iterator<vector> back_insert_iterator(vec);
534    vec.reserve(conf.copyright_alias().size());
535    std::copy(conf.copyright_alias().begin(), conf.copyright_alias().end(),
536              back_insert_iterator);
537    // sort with respect to Alias.id
538    IdCompare id;
539    PairSecondCompare<const std::string, Alias, IdCompare> comp(id);
540    std::sort(vec.begin(),vec.end(), comp);
541             
542
543    for (vector::const_iterator i(vec.begin()); i!=vec.end(); ++i) {
544      os << i->first << " = " << i->second.name() << "\n";
545    }
546
547    os << "\n"
548       << "### Section for images\n"
549       << "[image]\n"
550       << "format = " << conf.image_format() << "\n";
551    os << "anchor_format = " << conf.image_anchor_format() << "\n";
552
553
554    os << "\n"
555       << "### Section for author color in plots and blame output.\n"
556       << "[author-color]\n"
557       << "# jdoe = 000000\n";
558    typedef std::map<std::string,std::string> str_map;
559    for (str_map::const_iterator i(conf.author_color_.begin());
560         i!=conf.author_color_.end(); ++i) {
561      os << i->first << " = " << i->second << "\n";
562    }
563
564    os << "\n"
565       << "### Section for setting trac environment\n"
566       << "[trac]\n"
567       << "# If trac-root is set, svndigest will create anchors to "
568       << "the Trac page.\n"
569       << "# trac-root = http://dev.thep.lu.se/svndigest/\n";
570    if (!conf.trac_root().empty())
571      os << "trac-root = " << conf.trac_root() << "\n";
572
573    if (!conf.dictionary_.empty()) {
574      os << "\n"
575         << "### Section for setting dictionary for file names.\n"
576         << "### Prior looking for file name pattern in section " 
577         << "[parsing-codons],\n"
578         << "### the file name may be translated according to the rules \n"
579         << "### in this section. In default setting there is, for example,\n"
580         << "### a rule to translate `<FILENAME>.in' to `<FILENAME>'.\n"
581         << "### The format of the entries is:\n"
582         << "###    file-name-pattern = new-name\n"
583         << "### Left hand side may contain wildcards (such as '*' and '?').\n"
584         << "### Right hand side may contain \"$i\", which will be replaced \n"
585         << "### with the ith wild card in lhs string.\n"
586         << "[file-name-dictionary]\n";
587      for (size_t i=0; i<conf.dictionary_.size(); ++i)
588        os << conf.dictionary_[i].first << " = " 
589           << conf.dictionary_[i].second << "\n"; 
590    }
591    if (!conf.string2codons_.empty()) {
592      os << "\n"
593         << "### Section for setting parsing modes\n"
594         << "### The format of the entries is:\n"
595         << "###   file-name-pattern = \"start-code\" : \"end-code\"\n"
596         << "### The file-name-pattern may contain wildcards (such as '*' "
597         << "and '?').\n"
598         << "### String \"\\n\" can be used for codons containing newline"
599         << "\n### character.\n"
600         << "[parsing-codons]\n";
601      for (size_t i=0; i<conf.string2codons_.size(); ++i) {
602        os << conf.string2codons_[i].first << " = "; 
603        for (size_t j=0; j<conf.string2codons_[i].second.size(); ++j) {
604          if (j)
605            os << "  ;  ";
606          os << "\"" << trans_beg_code(conf.string2codons_[i].second[j].first) 
607             << "\":\"" 
608             << trans_end_code(conf.string2codons_[i].second[j].second) 
609             << "\""; 
610        }
611        os << "\n";
612      }
613    }
614    return os;
615  }
616
617 
618  Config_error::Config_error(const std::string& line,const std::string& message)
619    : std::runtime_error(std::string("line: `") + line + 
620                         std::string("' is invalid.\n") + message)
621  {}
622
623}} // end of namespace svndigest and namespace theplu
Note: See TracBrowser for help on using the repository browser.