source: trunk/lib/File.cc @ 538

Last change on this file since 538 was 538, checked in by Peter Johansson, 14 years ago

added ignore-cache option

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 11.3 KB
Line 
1// $Id: File.cc 538 2007-12-27 07:25:08Z 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 <cassert>
37#include <cstdio>
38#include <ctime>
39#include <fstream>
40#include <iostream>
41#include <map>
42#include <string>
43#include <sys/stat.h>
44
45namespace theplu{
46namespace svndigest{
47
48
49  File::File(const u_int level, const std::string& path, 
50             const std::string& output) 
51    : Node(level,path,output) 
52  {
53    output_dir_=output;
54    if (!output_dir_.empty())
55      output_dir_+='/';
56  }
57
58
59  std::map<int, std::set<Alias> >
60  File::copyright_map(std::map<std::string, Alias>& alias) const
61  {
62    using namespace std;
63    map<int, set<Alias> > year_authors;
64    SVNlog log(path());
65
66    assert(log.author().size()==log.date().size());
67    vector<string>::const_iterator author=log.author().begin();
68    for (vector<string>::const_iterator date=log.date().begin();
69         date!=log.date().end(); ++date, ++author) {
70      time_t sec = str2time(*date);
71      tm* timeinfo = gmtime(&sec);
72
73      // find username in map of aliases
74      std::map<string,Alias>::iterator name(alias.lower_bound(*author));
75
76      // if alias exist insert alias
77      if (name != alias.end() && name->first==*author)
78        year_authors[timeinfo->tm_year].insert(name->second);
79      else {
80        // else insert user name
81        Alias a(*author,alias.size());
82        year_authors[timeinfo->tm_year].insert(a);
83        std::cerr << "svndigest: warning: no copyright alias found for `" 
84                  << *author << "'\n";
85        // insert alias to avoid multiple warnings.
86        alias.insert(name, std::make_pair(*author, a));
87      }
88    }
89    return year_authors;
90  }
91
92
93  std::string
94  File::copyright_block(const std::map<int, std::set<Alias> >& year_authors,
95                        const std::string& prefix) const
96  {
97    using namespace std;
98    stringstream ss;
99    for (map<int, set<Alias> >::const_iterator i(year_authors.begin());
100         i!=year_authors.end();) {
101      ss << prefix << "Copyright (C) "
102          << 1900+i->first;
103      map<int, set<Alias> >::const_iterator j = i;
104      assert(i!=year_authors.end());
105      while (++j!=year_authors.end() && 
106             i->second == j->second){
107        ss << ", " << 1900+(j->first);
108      }
109      // printing authors
110      std::vector<Alias> vec_alias;
111      back_insert_iterator<std::vector<Alias> > ii(vec_alias);
112      std::copy(i->second.begin(), i->second.end(), ii);
113      // sort with respect to id
114      std::sort(vec_alias.begin(), vec_alias.end(), IdCompare());
115      for (std::vector<Alias>::iterator a=vec_alias.begin();
116           a!=vec_alias.end(); ++a){
117        if (a!=vec_alias.begin())
118          ss << ",";
119        ss << " " << a->name();
120      }
121      ss << "\n";
122      i = j;
123    }
124    return ss.str();
125  }
126
127  bool File::detect_copyright(std::string& block, size_t& start_at_line,
128                              size_t& end_at_line, std::string& prefix) const
129  {
130    using namespace std;
131    ifstream is(path().c_str());
132    assert(is.good());
133    string line;
134    bool found_copyright = false;
135    bool after_copyright = false;
136    size_t line_no=0;
137    while(getline(is, line) && !after_copyright){
138      ++line_no;
139      if (found_copyright){
140        // check if line is end of copyright statement, i.e. contains
141        // no alphanumerical character (except in prefix).
142        after_copyright = true;
143        for (size_t i=0; i<line.size()&&after_copyright; ++i)
144          if (isalnum(line[i]) && !(i<prefix.size() && prefix[i]==line[i])) {
145            after_copyright = false;
146            block += line + "\n";
147          }
148        if (after_copyright)
149          end_at_line=line_no;
150      }
151      else {
152        // check whether copyright starts on this line
153        string::iterator i = search(line.begin(), line.end(), "Copyright (C)");
154        if (i!=line.end()) {
155          start_at_line=line_no;
156          prefix = line.substr(0, distance(line.begin(), i));
157          found_copyright = true;
158          block = line + "\n";
159        }
160      }
161    }
162    is.close();
163    return found_copyright;
164  }
165
166
167  std::string File::href(void) const
168  { 
169    return name()+".html"; 
170  }
171
172
173  SVNlog File::log_core(void) const
174  {
175    return SVNlog(path());
176  }
177
178
179  std::string File::node_type(void) const
180  {
181    return std::string("file");
182  }
183
184
185  std::string File::output_path(void) const
186  {
187    return output_dir()+name()+".html";
188  }
189
190
191  const StatsCollection& File::parse(bool verbose, bool ignore)
192  {
193    if (verbose)
194      std::cout << "Parsing " << path_ << std::endl; 
195    stats_.reset();
196    std::string cache_dir = directory_name(path()) + std::string(".svndigest/"); 
197    std::string cache_file = cache_dir + name()+std::string(".svndigest-cache");
198    if (node_exist(cache_file)){
199      std::ifstream is(cache_file.c_str());
200      if (stats_.load_cache(is)){
201        return stats_;
202      }
203      is.close();
204    }
205    else
206      stats_.parse(path_);
207    if (!node_exist(cache_dir))
208      mkdir(cache_dir);
209    std::ofstream os(cache_file.c_str());
210    stats_.print(os);
211    os.close();
212    return stats_;
213  }
214
215
216  void File::print_blame(std::ofstream& os) const
217  {
218    os << "<br /><h3>Blame Information</h3>";
219    os << "<table class=\"blame\">\n";
220    os << "<thead>\n";
221    os << "<tr>\n";
222    os << "<th class=\"rev\">Rev</th>\n";
223    os << "<th class=\"date\">Date</th>\n";
224    os << "<th class=\"author\">Author</th>\n";
225    os << "<th class=\"line\">Line</th>\n";
226    os << "<th></th>\n";
227    os << "</tr>\n</thead>\n";
228    os << "<tbody>\n";
229    HtmlStream hs(os);
230    SVNblame blame(path_);
231    Parser parser(path_);
232    while (blame.valid()) {
233      parser.parse(blame.line());
234      blame.next_line();
235    }
236    blame.reset();
237
238    std::vector<Parser::line_type>::const_iterator
239      line_type(parser.type().begin());
240    int last=0;
241    int first=0;
242    bool using_dates=true;
243    if (GnuplotFE::instance()->dates().empty()){
244      using_dates=false;
245      last = stats_["classic"].revision();
246    }
247    else {
248      last = Date(GnuplotFE::instance()->dates().back()).seconds();
249      first = Date(GnuplotFE::instance()->dates()[0]).seconds();
250    }
251    // color is calculated linearly on time, c = kt + m
252    // brightest color (for oldest rev in log) is set to 192.
253    double k = 192.0/(first-last);
254    double m = -last*k; 
255    while (blame.valid()) {
256      std::string color;
257      if (using_dates)
258        color = hex(static_cast<int>(k*Date(blame.date()).seconds()+m),2);
259      else
260        color = hex(static_cast<int>(k*blame.revision()+m),2);
261      os << "<tr>\n<td class=\"rev\">";
262      std::stringstream color_ss;
263      color_ss << "#" << color << color << color; 
264      os << "<font color=\"" << color_ss.str() << "\">"
265         << trac_revision(blame.revision(), color_ss.str())
266         << "</font></td>\n<td class=\"date\"><font color=\"#" << color
267         << color << color << "\">" ;
268      hs << Date(blame.date())("%d %b %y");
269      os << "</font></td>\n<td class=\"author\">";
270      hs << blame.author();
271      os << "</td>\n<td class=\"";
272      assert(line_type!=parser.type().end());
273      if (*line_type==Parser::other)
274        os << "line-other";
275      else if (*line_type==Parser::comment)
276        os << "line-comment";
277      else
278        os << "line-code";
279      os << "\">" << blame.line_no()+1
280         << "</td>\n<td>";
281      hs << blame.line();
282      os << "</td>\n</tr>\n";
283      blame.next_line();
284      ++line_type;
285    }
286    os << "</tbody>\n";
287    os << "</table>\n";
288  }
289
290
291  void File::print_copyright(std::map<std::string, Alias>& alias, 
292                             bool verbose) const 
293  {
294    if (ignore())
295      return;
296
297    std::string old_block;
298    size_t start_line=0;
299    size_t end_line=0;
300    std::string prefix;
301    if (!detect_copyright(old_block, start_line, end_line, prefix)){
302      if (Configuration::instance().missing_copyright_warning())
303        std::cerr << "svndigest: warning: no copyright statement found in `" 
304                  << path_ << "'\n";
305      return;
306    }
307    std::map<int, std::set<Alias> > map=copyright_map(alias);
308    std::string new_block = copyright_block(map, prefix);
309    if (old_block==new_block)
310      return;
311    if (verbose)
312      std::cout << "Updating copyright in " << path_ << std::endl; 
313    update_copyright(new_block, start_line, end_line);
314  }
315
316
317  void File::print_core(const bool verbose) const 
318  {
319  }
320
321
322  void File::print_core(const std::string& stats_type, 
323                        const std::string& user, const std::string& line_type,
324                        const SVNlog& log) const 
325  {
326    std::string outpath = stats_type+"/"+user+"/"+line_type+"/"+local_path();
327    std::string imagefile = stats_type+"/"+"images/"+line_type+"/"+
328      local_path_+".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, local_path()+".html");
332    path_anchor(os);
333
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.