source: trunk/lib/File.cc @ 834

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

fixes #397. get latest rev from SVNinfo instead of SVNlog

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 12.8 KB
Line 
1// $Id: File.cc 834 2009-11-07 20:50:15Z 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  svn_revnum_t File::last_changed_rev(void) const
177  {
178    return svn_info().last_changed_rev();
179  }
180
181
182  void File::log_core(SVNlog&) const
183  {
184  }
185
186
187  std::string File::node_type(void) const
188  {
189    return std::string("file");
190  }
191
192
193  std::string File::output_path(void) const
194  {
195    return output_dir()+name()+".html";
196  }
197
198
199  const StatsCollection& File::parse(bool verbose, bool ignore)
200  {
201    if (verbose)
202      std::cout << "Parsing " << path_ << std::endl; 
203    stats_.reset();
204    std::string cache_dir = directory_name(path()) + std::string(".svndigest/"); 
205    std::string cache_file = cache_dir + name()+std::string(".svndigest-cache");
206    if (!ignore && node_exist(cache_file)){
207      std::ifstream is(cache_file.c_str());
208      if (stats_.load_cache(is)) {
209        is.close();
210        return stats_;
211      }
212      is.close();
213    }
214    else 
215      stats_.parse(path_);
216    if (!node_exist(cache_dir))
217      mkdir(cache_dir);
218    std::string tmp_cache_file(cache_file+"~");
219    std::ofstream os(tmp_cache_file.c_str());
220    stats_.print(os);
221    os.close();
222    rename(tmp_cache_file.c_str(), cache_file.c_str());
223    return stats_;
224  }
225
226
227  void File::print_blame(std::ofstream& os) const
228  {
229    os << "<br /><h3>" << local_path() << "</h3>";
230    os << "<div class=\"blame_legend\">\n";
231    os << "<dl>\n";
232    os << "<dt class=\"code\"></dt><dd>Code</dd>\n";
233    os << "<dt class=\"comment\"></dt><dd>Comments</dd>\n";
234    os << "<dt class=\"other\"></dt><dd>Other</dd>\n";
235    os << "</dl>\n</div>\n";
236    os << "<table class=\"blame\">\n";
237    os << "<thead>\n";
238    os << "<tr>\n";
239    os << "<th class=\"rev\">Rev</th>\n";
240    os << "<th class=\"date\">Date</th>\n";
241    os << "<th class=\"author\">Author</th>\n";
242    os << "<th class=\"line\">Line</th>\n";
243    os << "<th></th>\n";
244    os << "</tr>\n</thead>\n";
245    os << "<tbody>\n";
246    HtmlStream hs(os);
247    SVNblame blame(path_);
248    LineTypeParser parser(path_);
249    while (blame.valid()) {
250      parser.parse(blame.line());
251      blame.next_line();
252    }
253    blame.reset();
254
255    std::vector<LineTypeParser::line_type>::const_iterator
256      line_type(parser.type().begin());
257    int last=0;
258    int first=0;
259    bool using_dates=true;
260    if (GnuplotFE::instance()->dates().empty()){
261      using_dates=false;
262      last = stats_["classic"].revision();
263    }
264    else {
265      last = Date(GnuplotFE::instance()->dates().back()).seconds();
266      // earliest date corresponds either to revision 0 or revision 1
267      first = std::min(Date(GnuplotFE::instance()->dates()[0]).seconds(),
268                       Date(GnuplotFE::instance()->dates()[1]).seconds());
269    }
270    // color is calculated linearly on time, c = kt + m
271    // brightest color (for oldest rev in log) is set to 192.
272    double k = 192.0/(first-last);
273    double m = -last*k; 
274    while (blame.valid()) {
275      std::string color;
276      if (using_dates)
277        color = hex(static_cast<int>(k*Date(blame.date()).seconds()+m),2);
278      else
279        color = hex(static_cast<int>(k*blame.revision()+m),2);
280      os << "<tr>\n<td class=\"rev\">";
281      std::stringstream color_ss;
282      color_ss << "#" << color << color << color; 
283      os << "<font color=\"" << color_ss.str() << "\">"
284         << trac_revision(blame.revision(), color_ss.str())
285         << "</font></td>\n<td class=\"date\"><font color=\"#" << color
286         << color << color << "\">" ;
287      hs << Date(blame.date())("%d %b %y");
288      os << "</font></td>\n<td class=\"author\">";
289      std::string author_color = 
290        Configuration::instance().author_str_color(blame.author()); 
291      if (!author_color.empty())
292        os << "<font color=\"#" << author_color << "\">";
293      hs << blame.author();
294      os << "</td>\n<td class=\"";
295      assert(line_type!=parser.type().end());
296      if (*line_type==LineTypeParser::other)
297        os << "line-other";
298      else if (*line_type==LineTypeParser::comment || 
299               *line_type==LineTypeParser::copyright)       
300        os << "line-comment";
301      else if (*line_type==LineTypeParser::code)
302        os << "line-code";
303      else {
304        std::string msg="File::print_blame(): unexpected line type found";
305        throw std::runtime_error(msg);
306      }
307      os << "\">" << blame.line_no()+1
308         << "</td>\n<td>";
309      hs << blame.line();
310      os << "</td>\n</tr>\n";
311      blame.next_line();
312      ++line_type;
313    }
314    os << "</tbody>\n";
315    os << "</table>\n";
316  }
317
318
319  void File::print_copyright(std::map<std::string, Alias>& alias, 
320                             bool verbose,
321                             const std::map<int,svn_revnum_t>& y2rev) const 
322  {
323    if (ignore())
324      return;
325
326    std::string old_block;
327    size_t start_line=0;
328    size_t end_line=0;
329    std::string prefix;
330    if (!detect_copyright(old_block, start_line, end_line, prefix)){
331      if (Configuration::instance().missing_copyright_warning())
332        std::cerr << "svndigest: warning: no copyright statement found in `" 
333                  << path_ << "'\n";
334      return;
335    }
336    std::map<int, std::set<Alias> > map=copyright_map(alias, y2rev);
337    std::string new_block = copyright_block(map, prefix);
338    if (old_block==new_block)
339      return;
340    if (verbose)
341      std::cout << "Updating copyright in " << path_ << std::endl; 
342    update_copyright(new_block, start_line, end_line);
343  }
344
345
346  void File::print_core(const bool verbose) const 
347  {
348    std::ofstream os(blame_output_file_name().c_str());
349    assert(os.good());
350    print_html_start(os, "svndigest", level_+1);
351    print_blame(os);
352    print_footer(os);
353    os.close();
354  }
355
356
357  void File::print_core(const std::string& stats_type, 
358                        const std::string& user, const std::string& line_type,
359                        const SVNlog& log) const 
360  {
361    std::string lpath = local_path();
362    if (lpath.empty())
363      lpath = "index";
364    std::string outpath = stats_type+"/"+user+"/"+line_type+"/"+lpath;
365    std::string imagefile = stats_type+"/"+"images/"+line_type+"/"+
366      lpath+".png";
367    std::string html_name(outpath + ".html");
368    std::ofstream os(html_name.c_str());
369    print_header(os, name(), level_+3, user, line_type, lpath+".html",
370                 stats_type);
371    path_anchor(os);
372    os << "<p class=\"plot\">\n<img src='"; 
373    for (size_t i=0; i<level_; ++i)
374      os << "../";
375    os << "../../../";
376    if (user=="all")
377      os << stats_[stats_type].plot(imagefile,line_type);
378    else
379      os << imagefile;
380    os << "' alt='[plot]' />\n</p>";
381
382    print_author_summary(os, stats_[stats_type], line_type, log);
383    os << "\n";
384    os << "<h3>"
385       << anchor(blame_output_file_name(), 
386                 "Blame Information", level_+3) 
387       << "</h3>\n";
388
389    print_footer(os);
390    os.close(); 
391  }
392
393  void File::update_copyright(const std::string& new_block,
394                              size_t start_at_line, size_t end_at_line) const
395  {
396    // Code copied from Gnuplot -r70
397    char tmpname[]="/tmp/svndigestXXXXXX";
398    int fd=mkstemp(tmpname);  // mkstemp return a file descriptor
399    if (fd == -1)
400      throw std::runtime_error(std::string("Failed to get unique filename: ") +
401                               tmpname);
402    // Jari would like to do something like 'std::ofstream tmp(fd);'
403    // but has to settle for (which is stupid since the file is
404    // already open for writing.
405    std::ofstream tmp(tmpname);
406
407    using namespace std;
408    ifstream is(path().c_str());
409    assert(is.good());
410    string line;
411    // Copy lines before block
412    for (size_t i=1; i<start_at_line; ++i){
413      assert(is.good());
414      getline(is, line);
415      tmp << line << "\n";
416    }
417    // Printing copyright statement
418    tmp << new_block;
419    // Ignore old block lines
420    for (size_t i=start_at_line; i<end_at_line; ++i){
421      assert(is.good());
422      getline(is, line);
423    }
424    // Copy lines after block
425    while(is.good()) {
426      char ch=is.get();
427      if (is.good())
428        tmp.put(ch);
429    }
430
431    is.close();
432    tmp.close();
433    close(fd);
434    // get file permission
435    struct stat nodestat;
436    stat(path().c_str(),&nodestat);
437   
438    // finally copy temporary file to replace original file, and
439    // remove the temporary file
440    try {
441      copy_file(tmpname, path());
442    }
443    catch (std::runtime_error e) {
444      // catch exception, cleanup, and rethrow
445      std::cerr << "svndigest: File::print_copyright: Exception caught, "
446                << "removing temporary file " << tmpname << std::endl;
447      if (unlink(tmpname))
448        throw runtime_error(std::string("File::print_copyright: ") +
449                            "failed to unlink temporary file" + tmpname);
450      throw;
451    }
452    if (unlink(tmpname))
453      throw runtime_error(std::string("File::print_copyright: ") +
454                          "failed to unlink temporary file" + tmpname);
455
456    chmod(path().c_str(), nodestat.st_mode);
457  }
458
459
460}} // end of namespace svndigest and namespace theplu
Note: See TracBrowser for help on using the repository browser.