source: trunk/lib/File.cc @ 638

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

fixing copyright_test - refs #332

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