source: trunk/lib/File.cc @ 445

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

fixed #244, some printout when updating copyright in verbose mode

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