source: branches/visitor/lib/File.cc @ 1224

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

refs #476. Functions in Node structure that interacts with visitors.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 12.2 KB
Line 
1// $Id: File.cc 1224 2010-10-17 16:23:14Z peter $
2
3/*
4  Copyright (C) 2005, 2006, 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 "File.h"
24
25#include "Alias.h"
26#include "Colors.h"
27#include "Configuration.h"
28#include "Date.h"
29#include "Graph.h"
30#include "html_utility.h"
31#include "HtmlStream.h"
32#include "NodeVisitor.h"
33#include "Stats.h"
34#include "SVNblame.h"
35#include "SVNlog.h"
36
37#include <algorithm>
38#include <cassert>
39#include <cstdio>
40#include <ctime>
41#include <fstream>
42#include <iostream>
43#include <map>
44#include <stdexcept>
45#include <string>
46#include <sstream>
47#include <sys/stat.h>
48
49namespace theplu{
50namespace svndigest{
51
52
53  File::File(const unsigned int level, const std::string& path, 
54             const std::string& output) 
55    : Node(level,path,output)
56  {
57    output_dir_=output;
58    if (!output_dir_.empty())
59      output_dir_+='/';
60  }
61
62
63  std::string File::blame_output_file_name(void) const
64  {
65    return "blame_output/" + local_path() + ".html";
66  }
67
68
69  std::map<int, std::set<Alias> >
70  File::copyright_map(std::map<std::string, Alias>& alias,
71                      const std::map<int, svn_revnum_t>& year2rev) const
72  {
73    using namespace std;
74    map<int, set<Alias> > year_authors;
75    const Stats& stats = stats_["add"];
76
77    // loop over all years
78    for (std::map<int, svn_revnum_t>::const_iterator rev_iter=year2rev.begin();
79         rev_iter!=year2rev.end(); ++rev_iter) {
80
81      svn_revnum_t last_rev_this_year = rev_iter->second;
82      svn_revnum_t last_rev_last_year = 0;
83      if (rev_iter != year2rev.begin()) {
84        last_rev_last_year = (--rev_iter)->second;
85        ++rev_iter;
86      }
87      // do not go beyond BASE rev of file
88      last_rev_this_year = std::min(last_rev_this_year, last_changed_rev());
89      last_rev_last_year = std::min(last_rev_last_year, last_changed_rev());
90      // loop over authors
91      for (std::set<std::string>::const_iterator a_iter=stats.authors().begin();
92           a_iter!=stats.authors().end(); ++a_iter) {
93
94        // check if anything has been added since last year
95        if ( (stats(LineTypeParser::code, *a_iter, last_rev_this_year) >
96              stats(LineTypeParser::code, *a_iter, last_rev_last_year)) || 
97             (stats(LineTypeParser::comment, *a_iter, last_rev_this_year) >
98              stats(LineTypeParser::comment, *a_iter, last_rev_last_year)) ) {
99       
100       
101          // find username in map of aliases
102          std::map<string,Alias>::iterator name(alias.lower_bound(*a_iter));
103         
104          // if alias exist insert alias
105          if (name != alias.end() && name->first==*a_iter)
106            year_authors[rev_iter->first].insert(name->second);
107          else {
108            // else insert user name
109            Alias a(*a_iter,alias.size());
110            year_authors[rev_iter->first].insert(a);
111            std::cerr << "svncopyright: warning: no copyright alias found for `" 
112                      << *a_iter << "'\n";
113            // insert alias to avoid multiple warnings.
114            alias.insert(name, std::make_pair(*a_iter, a));
115          }
116        }
117      }
118    }
119    return year_authors;
120  }
121
122
123  std::string
124  File::copyright_block(const std::map<int, std::set<Alias> >& year_authors,
125                        const std::string& prefix) const
126  {
127    using namespace std;
128    stringstream ss;
129    for (map<int, set<Alias> >::const_iterator i(year_authors.begin());
130         i!=year_authors.end();) {
131      ss << prefix << Configuration::instance().copyright_string() << " "
132         << 1900+i->first;
133      map<int, set<Alias> >::const_iterator j = i;
134      assert(i!=year_authors.end());
135      while (++j!=year_authors.end() && 
136             i->second == j->second){
137        ss << ", " << 1900+(j->first);
138      }
139      // printing authors
140      std::vector<Alias> vec_alias;
141      back_insert_iterator<std::vector<Alias> > ii(vec_alias);
142      std::copy(i->second.begin(), i->second.end(), ii);
143      // sort with respect to id
144      std::sort(vec_alias.begin(), vec_alias.end(), IdCompare());
145      for (std::vector<Alias>::iterator a=vec_alias.begin();
146           a!=vec_alias.end(); ++a){
147        if (a!=vec_alias.begin())
148          ss << ",";
149        ss << " " << a->name();
150      }
151      ss << "\n";
152      i = j;
153    }
154    return ss.str();
155  }
156
157  bool File::detect_copyright(std::string& block, size_t& start_at_line,
158                              size_t& end_at_line, std::string& prefix) const
159  {
160    using namespace std;
161    LineTypeParser parser(path());
162    std::ifstream is(path().c_str());
163    std::string line;
164    while (std::getline(is, line)) 
165      parser.parse(line);
166    if (!parser.copyright_found())
167      return false;
168    block = parser.block();
169    start_at_line = parser.start_line();
170    end_at_line = parser.end_line();
171    prefix = parser.prefix();
172    return true;
173  }
174
175
176  std::string File::href(void) const
177  { 
178    return name()+".html"; 
179  }
180
181
182  svn_revnum_t File::last_changed_rev(void) const
183  {
184    return svn_info().last_changed_rev();
185  }
186
187
188  void File::log_core(SVNlog&) const
189  {
190  }
191
192
193  std::string File::node_type(void) const
194  {
195    return std::string("file");
196  }
197
198
199  std::string File::output_path(void) const
200  {
201    return output_dir()+name()+".html";
202  }
203
204
205  const StatsCollection& File::parse(bool verbose, bool ignore)
206  {
207    if (verbose)
208      std::cout << "Parsing '" << path_ << "'" << std::endl; 
209    stats_.reset();
210    std::string cache_dir = directory_name(path()) + std::string(".svndigest/"); 
211    std::string cache_file = cache_dir + name()+std::string(".svndigest-cache");
212    if (!ignore && node_exist(cache_file)){
213      std::ifstream is(cache_file.c_str());
214      if (stats_.load_cache(is)) {
215        is.close();
216        return stats_;
217      }
218      is.close();
219    }
220    else 
221      stats_.parse(path_);
222    if (!node_exist(cache_dir))
223      mkdir(cache_dir);
224    std::string tmp_cache_file(cache_file+"~");
225    std::ofstream os(tmp_cache_file.c_str());
226    stats_.print(os);
227    os.close();
228    rename(tmp_cache_file, cache_file);
229    return stats_;
230  }
231
232
233  void File::print_blame(std::ofstream& os) const
234  {
235    os << "<br /><h3>" << local_path() << "</h3>";
236    os << "<div class=\"blame_legend\">\n";
237    os << "<dl>\n";
238    os << "<dt class=\"code\"></dt><dd>Code</dd>\n";
239    os << "<dt class=\"comment\"></dt><dd>Comments</dd>\n";
240    os << "<dt class=\"other\"></dt><dd>Other</dd>\n";
241    os << "</dl>\n</div>\n";
242    os << "<table class=\"blame\">\n";
243    os << "<thead>\n";
244    os << "<tr>\n";
245    os << "<th class=\"rev\">Rev</th>\n";
246    os << "<th class=\"date\">Date</th>\n";
247    os << "<th class=\"author\">Author</th>\n";
248    os << "<th class=\"line\">Line</th>\n";
249    os << "<th></th>\n";
250    os << "</tr>\n</thead>\n";
251    os << "<tbody>\n";
252    HtmlStream hs(os);
253    SVNblame blame(path_);
254    LineTypeParser parser(path_);
255    while (blame.valid()) {
256      parser.parse(blame.line());
257      blame.next_line();
258    }
259    blame.reset();
260
261    std::vector<LineTypeParser::line_type>::const_iterator
262      line_type(parser.type().begin());
263    int last=0;
264    int first=0;
265    bool using_dates=true;
266    if (!Graph::date_xticks()) {
267      using_dates=false;
268      last = stats_["classic"].revision();
269    }
270    else {
271      last = Graph::xticks().back();
272      // earliest date corresponds either to revision 0 or revision 1
273      first = std::min(Graph::xticks()[0],Graph::xticks()[1]);
274    }
275    // color is calculated linearly on time, c = kt + m
276    // brightest color (for oldest rev in log) is set to 192.
277    double k = 192.0/(first-last);
278    double m = -last*k; 
279    while (blame.valid()) {
280      std::string color;
281      if (using_dates)
282        color = hex(static_cast<int>(k*Date(blame.date()).seconds()+m),2);
283      else
284        color = hex(static_cast<int>(k*blame.revision()+m),2);
285      os << "<tr>\n<td class=\"rev\">";
286      std::stringstream color_ss;
287      color_ss << "#" << color << color << color; 
288      os << "<font color=\"" << color_ss.str() << "\">"
289         << trac_revision(blame.revision(), color_ss.str())
290         << "</font></td>\n<td class=\"date\"><font color=\"#" << color
291         << color << color << "\">" ;
292      hs << Date(blame.date())("%d %b %y");
293      os << "</font></td>\n<td class=\"author\">";
294      const std::string& author_color = 
295        Colors::instance().color_str(blame.author());
296      assert(!author_color.empty());
297      os << "<font color=\"#" << author_color << "\">";
298      hs << blame.author();
299      os << "</td>\n<td class=\"";
300      assert(line_type!=parser.type().end());
301      if (*line_type==LineTypeParser::other)
302        os << "line-other";
303      else if (*line_type==LineTypeParser::comment || 
304               *line_type==LineTypeParser::copyright)       
305        os << "line-comment";
306      else if (*line_type==LineTypeParser::code)
307        os << "line-code";
308      else {
309        std::string msg="File::print_blame(): unexpected line type found";
310        throw std::runtime_error(msg);
311      }
312      os << "\">" << blame.line_no()+1
313         << "</td>\n<td>";
314      hs << blame.line();
315      os << "</td>\n</tr>\n";
316      blame.next_line();
317      ++line_type;
318    }
319    os << "</tbody>\n";
320    os << "</table>\n";
321  }
322
323
324  void File::print_copyright(std::map<std::string, Alias>& alias, 
325                             bool verbose,
326                             const std::map<int,svn_revnum_t>& y2rev) const 
327  {
328    if (ignore() || svncopyright_ignore())
329      return;
330
331    std::string old_block;
332    size_t start_line=0;
333    size_t end_line=0;
334    std::string prefix;
335    if (!detect_copyright(old_block, start_line, end_line, prefix)){
336      if (Configuration::instance().missing_copyright_warning())
337        std::cerr << "svncopyright: warning: no copyright statement found in `" 
338                  << path_ << "'\n";
339      return;
340    }
341    std::map<int, std::set<Alias> > map=copyright_map(alias, y2rev);
342    std::string new_block = copyright_block(map, prefix);
343    if (old_block==new_block)
344      return;
345    if (verbose)
346      std::cout << "Updating copyright in '" << path_ << "'" << std::endl; 
347    update_copyright(new_block, start_line, end_line);
348  }
349
350
351  void File::print_core(const bool verbose) const 
352  {
353    std::ofstream os(blame_output_file_name().c_str());
354    assert(os.good());
355    print_html_start(os, "svndigest", level_+1);
356    if (Configuration::instance().output_blame_information())
357      print_blame(os);
358    print_footer(os);
359    os.close();
360  }
361
362
363  void File::print_core(const std::string& stats_type, 
364                        const std::string& user, const std::string& line_type,
365                        const SVNlog& log) const 
366  {
367    std::string lpath = local_path();
368    if (lpath.empty())
369      lpath = "index";
370    std::string outpath = stats_type+"/"+user+"/"+line_type+"/"+lpath;
371    std::string imagefile = stats_type+"/"+"images/"+line_type+"/"+lpath;
372    std::string html_name(outpath + ".html");
373    std::ofstream os(html_name.c_str());
374    print_header(os, name(), level_+3, user, line_type, lpath+".html",
375                 stats_type);
376    path_anchor(os);
377
378    std::stringstream ss;
379    for (size_t i=0; i<level_; ++i)
380      ss << "../";
381    ss << "../../../";
382    if (user=="all")
383      ss << stats_[stats_type].plot(imagefile,line_type);
384    else
385      ss << imagefile;
386    os << "<p class=\"plot\">\n"; 
387    os << image(ss.str());
388    os << "</p>\n";
389
390    print_author_summary(os, stats_[stats_type], line_type, log);
391    os << "\n";
392    os << "<h3>"
393       << anchor(blame_output_file_name(), 
394                 "Blame Information", level_+3) 
395       << "</h3>\n";
396
397    print_footer(os);
398    os.close(); 
399  }
400
401
402  void File::traverse(NodeVisitor& visitor)
403  {
404    visitor.visit(*this);
405  }
406
407
408  void File::update_copyright(const std::string& new_block,
409                              size_t start_at_line, size_t end_at_line) const
410  {
411    // embrace filename with brackets #filename#
412    std::string tmpname = concatenate_path(directory_name(path()),
413                                           "#" + file_name(path()) + "#");
414    std::ofstream tmp(tmpname.c_str());
415
416    using namespace std;
417    ifstream is(path().c_str());
418    assert(is.good());
419    string line;
420    // Copy lines before block
421    for (size_t i=1; i<start_at_line; ++i){
422      assert(is.good());
423      getline(is, line);
424      tmp << line << "\n";
425    }
426    // Printing copyright statement
427    tmp << new_block;
428    // Ignore old block lines
429    for (size_t i=start_at_line; i<end_at_line; ++i){
430      assert(is.good());
431      getline(is, line);
432    }
433    // Copy lines after block
434    while(is.good()) {
435      char ch=is.get();
436      if (is.good())
437        tmp.put(ch);
438    }
439
440    is.close();
441    tmp.close();
442   
443    // finally rename file
444    rename(tmpname, path());
445  }
446
447
448}} // end of namespace svndigest and namespace theplu
Note: See TracBrowser for help on using the repository browser.