source: trunk/lib/File.cc @ 579

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

Merged patch release 0.6.5 to the trunk. Delta 0.6.5 - 0.6.4

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