source: trunk/lib/File.cc @ 653

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

refs #328 adding a map from year2last_rev - I only wanna create this function once so I create an extra layer and put the creation of map in the intermediate layer.

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