source: trunk/lib/File.cc @ 750

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

fixes #358

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