source: trunk/lib/Configuration.cc @ 523

Last change on this file since 523 was 523, checked in by Peter Johansson, 14 years ago

fixes ticket:284 - validate [file-name-dictionary] section in config file

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