source: trunk/lib/File.cc @ 476

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

fixed typo

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