source: trunk/lib/Configuration.cc @ 1008

Last change on this file since 1008 was 1008, checked in by Peter Johansson, 12 years ago

refs #405. support for fomrat none which is not really a format but images will be ignored.

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